Helm quick-start guide for operator, turtles and rancher #12

Danil-Grigorev · 2023-08-29T16:57:26Z

Fixes #7
Fixes #5

Deployed version: https://danil-grigorev.github.io/rancher-turtles-docs

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

… components Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

docs/getting-started/intro.md

docs/getting-started/install_capi_operator.md

docs/getting-started/install_turtles_operator.md

richardcase · 2023-08-30T15:11:37Z

docs/getting-started/install_turtles_operator.md

+1. Installing in in the same cluster as the rancher manager.
+
+Recommended path of installation for the operator is by using helm. To install it in your cluster you need to add repository first:


What do you think to covering how to install it via the Rancher Manager UI as well?

I think this is already covered in #19

richardcase · 2023-08-30T15:12:25Z

docs/getting-started/intro.md

+| Name                     | Version    | Details                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| ------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |


Also i think we need a banner saying that this is for early adopters only at this point.

Added a mention of early adopters contact in the table, should it lead somewhere specific?

docs/getting-started/rancher.md

docs/tasks/capi-operator/add_infrastructure_provider.md

docs/getting-started/install_capi_operator.md

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

richardcase

Looking good @Danil-Grigorev 🎉

docs/getting-started/install_capi_operator.md

docs/getting-started/install_turtles_operator.md

docs/getting-started/rancher.md

docs/tasks/capi-operator/add_infrastructure_provider.md

docs/getting-started/install_capi_operator.md

furkatgofurov7 · 2023-09-05T07:57:33Z

docs/tasks/capi-operator/add_infrastructure_provider.md

+This section describes how an infrastructure provider such as `Azure` could be added using `Cluster API Operator`.
+
+### Installing Azure Infrastructure Provider


should we refer to the capi operator docs instead of duplicating it? My concern is, keeping this up-to-date with capi operator docs might be challenging in the future

We can always pin it to a version of the operator docs to use, and the docs are describing a fixed state of some release of operator and turtles IMO. Additionally the value of the documentation is in simple access to the most common use cases in a single unified location. We may explore some better documentation options for the CAPI Operator, as a single README.md file is quite inconvenient to always refer to. It could clearly be separated into multiple sections.

+1 for deduplicating

- Add secrions for the CAPI operator installation as a dependency Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

docs/getting-started/install_turtles_operator.md

docs/getting-started/install_capi_operator.md

docs/getting-started/install_turtles_operator.md

alexander-demicev · 2023-09-06T11:20:29Z

docs/tasks/capi-operator/add_infrastructure_provider.md

+This section describes how an infrastructure provider such as `Azure` could be added using `Cluster API Operator`.
+
+### Installing Azure Infrastructure Provider


+1 for deduplicating

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

richardcase

Lets get this in. We can they do a complete review of all the docs

furkatgofurov7

Few suggestions for the future reference when we re-iterate over

furkatgofurov7 · 2023-09-18T13:11:34Z

docs/getting-started/install_capi_operator.md

+This section describes how to install `Cluster API Operator` in the Kubernetes cluster.
+
+## Installing CAPI and providers


Suggested change

## Installing CAPI and providers

## Installing Cluster API (CAPI) and providers

furkatgofurov7 · 2023-09-18T13:13:04Z

docs/getting-started/install_capi_operator.md

+
+### Install manually with Helm (alternative)
+To install `Cluster API Operator` with version `1.4.6` of the `CAPI` + `Docker` provider using helm, follow these steps:


I think it is worth mentioning why we are using specific CAPI version, v1.4.6 in this case and later versions of it can be used in the future due to some limitations of the Rancher ?

furkatgofurov7 · 2023-09-18T13:13:37Z

docs/getting-started/install_capi_operator.md

+helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
+```
+2. Update the Helm repository by running the following command:


Suggested change

2. Update the Helm repository by running the following command:

2. Update the Helm repository:

furkatgofurov7 · 2023-09-18T13:14:08Z

docs/getting-started/install_capi_operator.md

+helm repo update
+```
+3. Install the `Cluster API Operator` using the following command, which will also install `cert-manager`:


Suggested change

3. Install the `Cluster API Operator` using the following command, which will also install `cert-manager`:

3. Install the `Cluster API Operator`, which will also install `cert-manager`:

furkatgofurov7 · 2023-09-18T13:14:43Z

docs/getting-started/install_capi_operator.md

+	--timeout 90s --wait # Core Cluster API with kubeadm bootstrap and control plane providers will also be installed
+```
+*Note: `cert-manager` is a hard requirement for CAPI and `Cluster API Operator`*


Suggested change

*Note: `cert-manager` is a hard requirement for CAPI and `Cluster API Operator`*

*Note: `cert-manager` is a hard requirement for `CAPI`and `Cluster API Operator`*

furkatgofurov7 · 2023-09-18T13:18:48Z

docs/getting-started/install_capi_operator.md

+```
+
+The `infrastructure` flag is set to `docker:v1.4.6;azure:v1.4.6`, representing the desired provider names. This means that the `Cluster API Operator` will install and manage multiple provider systems, `Docker` and `Azure` respectively, with versions `1.4.6` specified.


Suggested change

The `infrastructure` flag is set to `docker:v1.4.6;azure:v1.4.6`, representing the desired provider names. This means that the `Cluster API Operator` will install and manage multiple provider systems, `Docker` and `Azure` respectively, with versions `1.4.6` specified.

The `infrastructure` flag is set to `docker:v1.4.6;azure:v1.4.6`, representing the desired provider names. This means that the `Cluster API Operator` will install and manage multiple providers, `Docker` and `Azure` respectively, with versions `v1.4.6` specified in this example.

furkatgofurov7 · 2023-09-18T13:21:29Z

docs/getting-started/install_turtles_operator.md

+*Note: In the future, we will support different deployment topologies*
+
+The recommended path of installation for the operator is by using `Helm`. To install it in the cluster, a repository should be added first:


Suggested change

The recommended path of installation for the operator is by using `Helm`. To install it in the cluster, a repository should be added first:

The recommended path of installation for the operator is by using `Helm`. To install it in the cluster, a chart repository should be added first:

furkatgofurov7 · 2023-09-18T13:21:57Z

docs/getting-started/install_turtles_operator.md

+*Note: this section will be extended with additional details later*
+
+A `rancher-turtles` repository should be added first:


Suggested change

A `rancher-turtles` repository should be added first:

A `rancher-turtles` chart repository should be added first:

furkatgofurov7 · 2023-09-18T13:24:28Z

docs/tasks/capi-operator/add_infrastructure_provider.md

+### Deleting providers
+
+To remove the installed providers and all related kubernetes objects just delete the following CRs:


Suggested change

To remove the installed providers and all related kubernetes objects just delete the following CRs:

To remove the installed providers and all related Kubernetes objects, just delete the following CRs:

furkatgofurov7 · 2023-09-18T13:24:50Z

docs/tasks/capi-operator/basic_cluster_api_provider_installation.md

+
+# Basic Cluster API Provider Installation
+
+This section describes the basic process of installing `CAPI` providers using the operator. The `Cluster API Operator` manages five types of objects:


Suggested change

This section describes the basic process of installing `CAPI` providers using the operator. The `Cluster API Operator` manages five types of objects:

This section describes the basic process of installing `CAPI` providers using the operator. The `Cluster API Operator` manages five types of provider objects:

Danil-Grigorev added 4 commits August 30, 2023 11:01

Add Rancher getting started content

6ac6708

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Add prereqisites section details with a list of supported versions of…

a8dee3a

… components Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Add CAPI operator install section

cef96ec

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Add rancher-turtles install section

5df3b7c

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Danil-Grigorev force-pushed the quickstart-operator branch from 58e64de to 148e7e3 Compare August 30, 2023 09:03

Add CAPI operator description of how to install an infra provider

ec8b0c5

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Danil-Grigorev force-pushed the quickstart-operator branch from 148e7e3 to ec8b0c5 Compare August 30, 2023 09:32

Danil-Grigorev marked this pull request as ready for review August 30, 2023 09:33

Danil-Grigorev requested a review from richardcase August 30, 2023 09:33

richardcase reviewed Aug 30, 2023

View reviewed changes

furkatgofurov7 reviewed Aug 31, 2023

View reviewed changes

docs/getting-started/install_capi_operator.md Outdated Show resolved Hide resolved

Danil-Grigorev force-pushed the quickstart-operator branch 2 times, most recently from 9d39ffc to 4bc0010 Compare August 31, 2023 11:08

Danil-Grigorev added 2 commits August 31, 2023 15:13

Use third person statementsacross the docs

a3a680e

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Add section for installing in existing rancher cluster

da3f412

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Danil-Grigorev force-pushed the quickstart-operator branch from 4bc0010 to da3f412 Compare August 31, 2023 13:27

richardcase reviewed Aug 31, 2023

View reviewed changes

Danil-Grigorev force-pushed the quickstart-operator branch 2 times, most recently from 8d4d87c to 2498461 Compare September 4, 2023 20:49

furkatgofurov7 reviewed Sep 5, 2023

View reviewed changes

Danil-Grigorev force-pushed the quickstart-operator branch 2 times, most recently from 0c452fc to 0d490e5 Compare September 5, 2023 08:14

Rewrite docs and separate content for a more human readable structure

217f9d1

- Add secrions for the CAPI operator installation as a dependency Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Danil-Grigorev force-pushed the quickstart-operator branch from 0d490e5 to 217f9d1 Compare September 5, 2023 08:34

richardcase reviewed Sep 5, 2023

View reviewed changes

docs/getting-started/install_turtles_operator.md Show resolved Hide resolved

docs/getting-started/install_turtles_operator.md Outdated Show resolved Hide resolved

alexander-demicev reviewed Sep 6, 2023

View reviewed changes

Danil-Grigorev force-pushed the quickstart-operator branch 3 times, most recently from a79f0c7 to 95aa333 Compare September 18, 2023 12:22

Danil-Grigorev requested a review from richardcase September 18, 2023 12:30

Danil-Grigorev requested review from alexander-demicev and furkatgofurov7 September 18, 2023 12:30

Danil-Grigorev force-pushed the quickstart-operator branch from 95aa333 to 82dd05b Compare September 18, 2023 12:34

Add updated details on rancher turtles installation with capi opearator

04615c7

Signed-off-by: Danil Grigorev <danil.grigorev@suse.com>

Danil-Grigorev force-pushed the quickstart-operator branch from 82dd05b to 04615c7 Compare September 18, 2023 12:36

richardcase approved these changes Sep 18, 2023

View reviewed changes

furkatgofurov7 approved these changes Sep 18, 2023

View reviewed changes

Danil-Grigorev merged commit 222a1bd into rancher:main Sep 18, 2023
2 checks passed

Danil-Grigorev mentioned this pull request Sep 25, 2023

📖 Update quickstart to reflect requested changes #26

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Helm quick-start guide for operator, turtles and rancher #12

Helm quick-start guide for operator, turtles and rancher #12

Danil-Grigorev commented Aug 29, 2023 •

edited

Loading

richardcase Aug 30, 2023

Danil-Grigorev Sep 18, 2023

richardcase Aug 30, 2023

Danil-Grigorev Aug 31, 2023

richardcase left a comment

furkatgofurov7 Sep 5, 2023

Danil-Grigorev Sep 5, 2023

alexander-demicev Sep 6, 2023

alexander-demicev Sep 6, 2023

richardcase left a comment

furkatgofurov7 left a comment

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

furkatgofurov7 Sep 18, 2023

		1. Installing in in the same cluster as the rancher manager.

		Recommended path of installation for the operator is by using helm. To install it in your cluster you need to add repository first:

		\| Name \| Version \| Details \|
		\| ------------------------ \| ---------- \| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \|

		This section describes how an infrastructure provider such as `Azure` could be added using `Cluster API Operator`.

		### Installing Azure Infrastructure Provider

		This section describes how to install `Cluster API Operator` in the Kubernetes cluster.

		## Installing CAPI and providers

	## Installing CAPI and providers
	## Installing Cluster API (CAPI) and providers


		### Install manually with Helm (alternative)
		To install `Cluster API Operator` with version `1.4.6` of the `CAPI` + `Docker` provider using helm, follow these steps:

	2. Update the Helm repository by running the following command:
	2. Update the Helm repository:

	3. Install the `Cluster API Operator` using the following command, which will also install `cert-manager`:
	3. Install the `Cluster API Operator`, which will also install `cert-manager`:

	Note: `cert-manager` is a hard requirement for CAPI and `Cluster API Operator`
	Note: `cert-manager` is a hard requirement for `CAPI`and `Cluster API Operator`

		```

		The `infrastructure` flag is set to `docker:v1.4.6;azure:v1.4.6`, representing the desired provider names. This means that the `Cluster API Operator` will install and manage multiple provider systems, `Docker` and `Azure` respectively, with versions `1.4.6` specified.

		Note: In the future, we will support different deployment topologies

		The recommended path of installation for the operator is by using `Helm`. To install it in the cluster, a repository should be added first:

		Note: this section will be extended with additional details later

		A `rancher-turtles` repository should be added first:

	A `rancher-turtles` repository should be added first:
	A `rancher-turtles` chart repository should be added first:

		### Deleting providers

		To remove the installed providers and all related kubernetes objects just delete the following CRs:


		# Basic Cluster API Provider Installation

		This section describes the basic process of installing `CAPI` providers using the operator. The `Cluster API Operator` manages five types of objects:

Helm quick-start guide for operator, turtles and rancher #12

Helm quick-start guide for operator, turtles and rancher #12

Conversation

Danil-Grigorev commented Aug 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richardcase left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richardcase left a comment

Choose a reason for hiding this comment

furkatgofurov7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Danil-Grigorev commented Aug 29, 2023 •

edited

Loading