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

📖 Assorted docs updates #1318

Merged
merged 1 commit into from
Oct 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions docs/book/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Managing Kubernetes Infrastructure with the Cluster API
Copy link
Member

Choose a reason for hiding this comment

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

This file seems extra


* [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)

20 changes: 11 additions & 9 deletions docs/book/src/SUMMARY.md
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)
16 changes: 16 additions & 0 deletions docs/book/src/architecture/controllers/bootstrap.md
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)
3 changes: 3 additions & 0 deletions docs/book/src/architecture/controllers/cluster.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Cluster Controller

![](../../images/cluster-admission-cluster-controller.svg)
Copy link
Member

Choose a reason for hiding this comment

The 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`.
Expand Down Expand Up @@ -67,3 +69,4 @@ formatted as described below.
| Secret name | Field name | Content |
|:---:|:---:|:---:|
|`<cluster-name>-kubeconfig`|`value`|base64 encoded kubeconfig|

Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# MachineDeployment

<!-- TODO -->
This page is still being written - stay tuned!
2 changes: 1 addition & 1 deletion docs/book/src/architecture/controllers/machine-set.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# MachineSet

<!-- TODO -->
This page is still being written - stay tuned!
5 changes: 5 additions & 0 deletions docs/book/src/architecture/controllers/machine.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Machine Controller

![](../../images/cluster-admission-machine-controller.svg)

The Machine controller's main responsibilities are:

* Setting an OwnerReference on:
Expand All @@ -9,6 +11,7 @@ The Machine controller's main responsibilities are:
* Copy data from `BootstrapConfig.Status.BootstrapData` to `Machine.Spec.Bootstrap.Data` if
`Machine.Spec.Bootstrap.Data` is empty.
* Setting NodeRefs to be able to associate machines and kubernetes nodes.
* Deleting Nodes in the target cluster when the associated machine is deleted.
* Cleanup of related objects.
* Keeping the Machine's Status object up to date with the InfrastructureMachine's Status object.

Expand Down Expand Up @@ -95,3 +98,5 @@ The Machine controller will create a secret or use an existing secret in the fol
| secret name | field name | content |
|:---:|:---:|---|
|`<cluster-name>-kubeconfig`|`value`|base64 encoded kubeconfig that is authenticated with the child cluster|


1 change: 1 addition & 0 deletions docs/book/src/architecture/controllers/node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Node Controller
26 changes: 26 additions & 0 deletions docs/book/src/images/cluster-admission-cluster-controller.plantuml
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.
Loading