Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation to adapt to new gRPC services #221

Merged
merged 5 commits into from
Feb 13, 2019

Conversation

prashanth26
Copy link
Contributor

@prashanth26 prashanth26 commented Feb 11, 2019

What this PR does / why we need it:
Updated documentation and code while adding new provider support using new gRPC services.

Which issue(s) this PR fixes:
Fixes #215

Special notes for your reviewer:

Release note:

NONE

cc: @afritzler

@prashanth26 prashanth26 added kind/enhancement Enhancement, improvement, extension exp/beginner Issue that requires only basic skills needs/review Needs review area/documentation Documentation related status/new Issue is new and unprocessed component/machine-controller-manager platform/all area/quality Output qualification (tests, checks, scans, automation in general, etc.) related size/s Size of pull request is small (see gardener-robot robot/bots/size.py) labels Feb 11, 2019
@prashanth26 prashanth26 requested review from ggaurav10 and a team as code owners February 11, 2019 14:17
@prashanth26 prashanth26 changed the title Cmi client Updated documentation to adapt to new gRPC services Feb 11, 2019
```
1. Navigate into the newly created repository.
1. Navigate into the newly directory.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

1. Fill in the methods described at `pkg/{provider-name}/machineserver.go` to manage VMs on your cloud provider.
- To test the basic working of your driver, implementing just the create & delete would suffice.
- The request and response parameters for each of the methods to be implemented are well documented as comments and sample codes at `pkg/{provider-name}/machineserver.go`.
- Once, create and delete methods behave as expected, you can fill in the rest of the methods.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hoped we would have expected a user to implement GetMachine as well, seems something very basic to be implemented for features like safety-controller and in case we implement GetMachine before every CreateMachine call on mcm. Leaving the decision to you.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hardikdr hardikdr merged commit cfb2596 into gardener:cmi-client Feb 13, 2019
prashanth26 added a commit that referenced this pull request Sep 11, 2019
* Made changes to gRPC services

* Better error messages and logging

* Updated provider docs to adopt documentation to new gRPC services

* Updated docs

* Made suggested changes in documentation
@ghost ghost added the component/mcm Machine Controller Manager (including Node Problem Detector, Cluster Auto Scaler, etc.) label Mar 7, 2020
@gardener-robot gardener-robot added priority/3 Priority (lower number equals higher priority) and removed priority/3 Priority (lower number equals higher priority) labels Mar 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related area/quality Output qualification (tests, checks, scans, automation in general, etc.) related component/mcm Machine Controller Manager (including Node Problem Detector, Cluster Auto Scaler, etc.) exp/beginner Issue that requires only basic skills kind/enhancement Enhancement, improvement, extension needs/review Needs review platform/all size/s Size of pull request is small (see gardener-robot robot/bots/size.py) status/new Issue is new and unprocessed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants