Skip to content

Commit

Permalink
Move content to correct sections for generated summary
Browse files Browse the repository at this point in the history
Signed-off-by: Danil Grigorev <[email protected]>
  • Loading branch information
Danil-Grigorev committed Mar 6, 2024
1 parent 978da7f commit 9f992a3
Show file tree
Hide file tree
Showing 40 changed files with 70 additions and 65 deletions.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/book/src/01_user/00.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# User guide

This section contains quick start and concepts relevant to a new operator user.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This is a quickstart guide for getting Cluster API Operator up and running on your Kubernetes cluster.

For more detailed information, please refer to the full documentation.

## Prerequisites

- [Running Kubernetes cluster](https://cluster-api.sigs.k8s.io/user/quick-start#install-andor-configure-a-kubernetes-cluster).
Expand All @@ -25,42 +27,47 @@ kubectl create secret generic "${CREDENTIALS_SECRET_NAME}" --from-literal=AWS_B6

### Installing Cluster API Operator

#### Method 1: Apply Manifests from Release Assets

Before installing the Cluster API Operator this way, you must first ensure that cert-manager is installed, as the operator does not manage cert-manager installations. To install cert-manager, run the following command:

```bash
kubectl apply -f https://github.com/jetstack/cert-manager/releases/latest/download/cert-manager.yaml
```

Wait for cert-manager to be ready before proceeding.

After cert-manager is successfully installed, you can install the Cluster API operator directly by applying the latest release assets:
Add helm repository:

```bash
kubectl apply -f https://github.com/kubernetes-sigs/cluster-api-operator/releases/latest/download/operator-components.yaml
helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
helm repo update
```

#### Method 2: Use Helm Charts

Alternatively, you can install the Cluster API operator using Helm charts:
Deploy Cluster API components with docker provider using a single command during operator installation

```bash
helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
helm repo update
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set cert-manager.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
```

##### Installing cert-manager using Helm chart
Docker provider can be replaced by any provider supported by [clusterctl](https://cluster-api.sigs.k8s.io/reference/providers.html#infrastructure).

CAPI operator Helm chart supports provisioning of cert-manager as a dependency. It is disabled by default, but you can enable it with `--set cert-manager.enabled=true` option to `helm install` command or inside of `cert-manager` section in [values.yaml](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/hack/charts/cluster-api-operator/values.yaml) file. Additionally you can define other [parameters](https://artifacthub.io/packages/helm/cert-manager/cert-manager#configuration) provided by the cert-manager chart.
Other options for installing Cluster API Operator are described in [installation documentation](../02_installation/).

# Example API Usage

##### Installing providers using Helm chart
Deploy latest version of core Cluster API components:

Deploy Cluster API components with docker provider using a single command during operator installation:
```yaml
apiVersion: operator.cluster.x-k8s.io/v1alpha2
kind: CoreProvider
metadata:
name: cluster-api
namespace: capi-system

```bash
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set cert-manager.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
```

Docker provider can be replaced by any provider supported by [clusterctl](https://cluster-api.sigs.k8s.io/reference/providers.html#infrastructure).
Deploy Cluster API AWS provider with specific version, custom manager options and flags:

```yaml
---
apiVersion: operator.cluster.x-k8s.io/v1alpha2
kind: InfrastructureProvider
metadata:
name: aws
namespace: capa-system
spec:
version: v2.1.4
configSecret:
name: aws-variables
```
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions docs/book/src/03_topics/01_capi-providers-lifecycle/00.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Cluster API Provider Lifecycle

This section contains lifecycle operations a user can perform on a provider manifest, such as:
- Install
- Upgrade
- Modify
- Delete
3 changes: 3 additions & 0 deletions docs/book/src/03_topics/02_configuration/00.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Configuration

This section contains a list of frequent configuration tasks for CAPI Operator providers.
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ spec:

5. As an admin, I would like to use the default fetch configurations by simply specifying the expected Cluster API provider names such as `aws`, `vsphere`, `azure`, `kubeadm`, `talos`, or `cluster-api` instead of having to explicitly specify the fetch configuration. In the example below, since we are using 'vsphere' as the name of the InfrastructureProvider the operator will fetch it's configuration from `url: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases` by default.

See more examples in the [air-gapped environment section](#air-gapped-environment)
See more examples in the [air-gapped environment section](./01_air-gapped-environtment.md)

```yaml
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Configuration

## Provider Spec
# Provider Spec

1. `ProviderSpec`: desired state of the Provider, consisting of:
- Version (string): provider version (e.g., "v0.1.0")
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Basic Cluster API provider installation

This section provides an example to a CAPZ provider installation.
6 changes: 6 additions & 0 deletions docs/book/src/04_developer/00.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Developer

This section contains regular developer tasks, such as:
- Release
- Development guide
- Migration guide
File renamed without changes.
File renamed without changes.
8 changes: 8 additions & 0 deletions docs/book/src/05_reference/00.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Reference

- [API reference](./01_api_reference.md)
- [Glossary](./02_glossary.md)
- [Code of Conduct](./03_code-of-conduct.md)
- [Contributing](./04_contributing.md)
- [CI Jobs](./05_ci-jobs.md)
- [Providers](./06_providers.md)
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/book/src/05_reference/03_code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

{{#include ../../../../code-of-conduct.md}}
3 changes: 3 additions & 0 deletions docs/book/src/05_reference/04_contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing

{{#include ../../../../CONTRIBUTING.md}}
File renamed without changes.
File renamed without changes.
1 change: 0 additions & 1 deletion docs/book/src/CONTRIBUTING.MD

This file was deleted.

30 changes: 0 additions & 30 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,30 +0,0 @@
# Summary

[Introduction](./introduction.md)
[Quick Start](./user/quick-start.md)
- [Installation](./installation/installation.md)
- [Using plugin](./installation/plugin-installation.md)
- [Using Manifests from Release Assets](./installation/manifest-installation.md)
- [Using Helm Charts](./installation/helm-chart-installation.md)
[Concepts](./user/concepts.md)
- [Topics](./topics/topics.md)
- [Cluster API Provider Lifecycle](./topics/capi-provides-lifecycle.md)
- [Installing a Provider](./topics/installing-provider.md)
- [Upgrading a Provider](./topics/upgrading-provider.md)
- [Modifying a Provider](./topics/modifying-provider.md)
- [Deleting a Provider](./topics/deleting-provider.md)
- [Basic Cluster API Provider Installation](./topics/basic-capi-provider-installation.md)
- [Installing the CoreProvider](./topics/installing-core-provider.md)
- [Installing Azure Infrastructure Provider](./topics/installing-capz.md)
- [Deleting providers](./topics/deleting-providers.md)
- [Air-gapped Environment](./topics/air-gapped-environtment.md)
- [Injecting additional manifests](./topics/injecting-additional-manifests.md)
- [Developer Guide](./developer/guide.md)
- [Releasing](./developer/release.md)
- [Version migration](./developer/v1alpha1-to-v1alpha2.md)
- [Reference](./reference/reference.md)
- [API Reference](./reference/api_reference.md)
- [Glossary](./reference/glossary.md)
- [Code of Conduct](./code-of-conduct.md)
- [Contributing](./CONTRIBUTING.md)
- [CI Jobs](./reference/ci-jobs.md)
3 changes: 0 additions & 3 deletions docs/book/src/code-of-conduct.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/book/src/reference/reference.md

This file was deleted.

This file was deleted.

0 comments on commit 9f992a3

Please sign in to comment.