-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
📖 Assorted docs updates #1318
Merged
Merged
📖 Assorted docs updates #1318
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Managing Kubernetes Infrastructure with the Cluster API | ||
|
||
* [Introduction](README.md) | ||
|
||
## Getting Started | ||
|
||
* [Abbreviations](ABBREVIATIONS.md) | ||
* [Glossary](GLOSSARY.md) | ||
* [Interoperability](getting_started/interoperability.md) | ||
* [Existing Providers](getting_started/existing_providers.md) | ||
|
||
## Common Code | ||
|
||
* [Architecture](common_code/architecture.md) | ||
* [Repository Layout](common_code/repository_layout.md) | ||
* [Cluster Controller](common_code/cluster_controller.md) | ||
* [Machine Controller](common_code/machine_controller.md) | ||
* [MachineSet Controller](common_code/machineset_controller.md) | ||
* [MachineDeployment Controller](common_code/machinedeployment_controller.md) | ||
* [NodeRef Controller](common_code/noderef_controller.md) | ||
* [Node Controller](common_code/node_controller.md) | ||
|
||
## Creating a New Provider | ||
|
||
* [Overview](provider_implementations/overview.md) | ||
* [Naming](provider_implementations/naming.md) | ||
* [Generate CRDs](provider_implementations/generate_crds.md) | ||
* [Register Schemes](provider_implementations/register_schemes.md) | ||
* [Create Actuators](provider_implementations/create_actuators.md) | ||
* [Register Controllers](provider_implementations/register_controllers.md) | ||
* [Building, Running, and Testing](provider_implementations/building_running_and_testing.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,26 @@ | ||
# Summary | ||
|
||
[Introduction](./introduction.md) | ||
|
||
- [User Guide](./user/guide.md) | ||
- [Concepts](./user/concepts.md) | ||
- [Quick Start](./user/quick-start.md) | ||
|
||
[Quick Start](./user/quick-start.md) | ||
[Concepts](./user/concepts.md) | ||
- [Tasks](./tasks/index.md) | ||
- [Installation](./tasks/installation.md) | ||
- [Certificate Management](./tasks/certs/index.md) | ||
- [Using Custom Certificates](./tasks/certs/using-custom-certificates.md) | ||
- [Generating a Kubeconfig](./tasks/certs/generate-kubeconfig.md) | ||
- [Developer Guide](./architecture/developer-guide.md) | ||
- [Repository Layout](./architecture/repository-layout.md) | ||
- [Controllers](./architecture/controllers.md) | ||
- [Bootstrap](./architecture/controllers/bootstrap.md) | ||
- [Cluster](./architecture/controllers/cluster.md) | ||
- [Machine](./architecture/controllers/machine.md) | ||
- [MachineSet](./architecture/controllers/machine-set.md) | ||
- [MachineDeployment](./architecture/controllers/machine-deployment.md) | ||
- [Node](./architecture/controllers/node.md) | ||
- [Provider Implementers](./providers/implementers.md) | ||
- [v1alpha1 to v1alpha2](./providers/v1alpha1-to-v1alpha2.md) | ||
- [Tooling](./tooling/tooling.md) | ||
- [Clusterctl](./tooling/clusterctl.md) | ||
|
||
- [Reference](./reference/reference.md) | ||
- [Abbreviations](./reference/abbreviations.md) | ||
- [Glossary](./reference/glossary.md) | ||
- [Providers](./reference/providers.md) | ||
- [Provider List](./reference/providers.md) | ||
- [clusterctl CLI](./tooling/clusterctl.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Bootstrap Controller | ||
<!-- TODO --> | ||
Bootstrapping is the process in which: | ||
|
||
1. A cluster is bootstrapped | ||
1. A machine is bootstrapped and takes on a role within a cluster | ||
|
||
[CAPBK](https://github.com/kubernetes-sigs/cluster-api-bootstrap-provider-kubeadm) is the reference bootstrap provider and is based on `kubeadm`. CAPBK codifies the steps for [creating a cluster](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/) in multiple configurations. | ||
|
||
![](../../images/bootstrap-controller.png) | ||
|
||
See [proposal](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20190610-machine-states-preboot-bootstrapping.md) for the full details on how the bootstrap process works. | ||
|
||
### Implementations | ||
|
||
* [Kubeadm](https://github.com/kubernetes-sigs/cluster-api-bootstrap-provider-kubeadm) (Reference Implementation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# Cluster Controller | ||
|
||
![](../../images/cluster-admission-cluster-controller.svg) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The image linked seems to be missing? |
||
|
||
The Cluster controller's main responsibilities are: | ||
|
||
* Setting an OwnerReference on the infrastructure object referenced in `Cluster.Spec.InfrastructureRef`. | ||
|
@@ -67,3 +69,4 @@ formatted as described below. | |
| Secret name | Field name | Content | | ||
|:---:|:---:|:---:| | ||
|`<cluster-name>-kubeconfig`|`value`|base64 encoded kubeconfig| | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
# MachineDeployment | ||
|
||
<!-- TODO --> | ||
This page is still being written - stay tuned! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# MachineSet | ||
|
||
<!-- TODO --> | ||
This page is still being written - stay tuned! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Node Controller |
File renamed without changes.
File renamed without changes
26 changes: 26 additions & 0 deletions
26
docs/book/src/images/cluster-admission-cluster-controller.plantuml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
@startuml cluster-admission-cluster-controller | ||
|
||
start; | ||
:Cluster controller; | ||
|
||
repeat | ||
:Cluster controller enqueues a Reconcile call; | ||
if (Cluster has ready annotation) then (no) | ||
#LightBlue:Get control plane machines for cluster; | ||
if (A control plane machine is ready) then (yes) | ||
#LightBlue:Set Cluster Ready annotation; | ||
#LightBlue:Patch Cluster back to API server; | ||
else (no) | ||
#Pink:Return RequeueError; | ||
endif | ||
endif | ||
repeat while (Reconcile returned RequeueError) is (yes) | ||
-> no; | ||
if (Reconcile returned error) then (yes) | ||
#Pink:Error reconciling cluster; | ||
else (no) | ||
#LightBlue:Cluster is ready; | ||
endif | ||
stop; | ||
|
||
@enduml |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file seems extra