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.

Sign up for GitHub

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

📖clusterctl: update docs after fix-webhooks #2338

Merged
merged 1 commit into from
Feb 14, 2020
Merged

📖clusterctl: update docs after fix-webhooks #2338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/book/src/clusterctl/commands/delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ the provider's CRDs.

<h1>Warning</h1>

If you want to delete the namespace where the provider components are hosted, you can use the `--delete-namespace` flag.
If you want to delete the namespace where the provider components are hosted, you can use the `--include-namespace` flag.

Be aware that this operation deletes all the object existing in a namespace, not only the provider's components.

Expand All @@ -25,7 +25,8 @@ Be aware that this operation deletes all the object existing in a namespace, not

<h1>Warning</h1>

If you want to delete the provider's CRDs, you can use the `--delete-crd` flag.
If you want to delete the provider's CRDs, and all the components related to CRDs like e.g. the ValidatingWebhookConfiguration etc.,
you can use the `--include-crd` flag.

Be aware that this operation deletes all the object of Kind defined in the provider's CRDs, e.g. when deleting
the aws provider, it deletes all the `AWSCluster`, `AWSMachine` etc.
Expand Down
20 changes: 18 additions & 2 deletions docs/book/src/clusterctl/provider-contract.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,25 @@ It is strongly recommended that:
* Bootstrap providers release a file called ` bootstrap-components.yaml`
* Control plane providers release a file called `control-plane-components.yaml`

#### Shared and instance components

The objects contained in a component YAML file can be divided in two sets:

- Instance specific objects, like the Deployment for the controller, the ServiceAccount used for running the controller
and the related RBAC rules.
- The objects that are shared among all the provider instances, like e.g. CRDs, ValidatingWebhookConfiguration or the
Deployment implementing the web-hook servers and related Service and Certificates.

As per the Cluster API contract, all the shared objects are expected to be deployed in a namespace named `capi-webhook-system`
(if applicable).

clusterctl implements a different lifecycle for shared resources e.g.
- ensuring that the version of the shared objects for each provider matches the latest version installed in the cluster.
- ensuring that deleting an instance of a provider does not destroy shared resources unless explicitly requested by the user.

#### Target namespace

The components YAML should contain one Namespace object, which will be used as the default target namespace
The instance components should contain one Namespace object, which will be used as the default target namespace
when creating the provider components.

All the objects in the components YAML MUST belong to the target namespace, with the exception of objects that
Expand Down Expand Up @@ -276,4 +292,4 @@ Additionally, provider authors should be aware that `clusterctl move` assumes al

### Adopt

WIP
TODO