From 7b7c4021f361ebc0f52495b7da6914e6f082905d Mon Sep 17 00:00:00 2001 From: Eneko Fernandez Date: Thu, 16 Nov 2023 16:49:46 +0000 Subject: [PATCH 1/3] some suggestion while reading the docs --- .../install-enterprise-cli.mdx | 40 ++++++++++--------- 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx index bbf465a848..7b30d20634 100644 --- a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx +++ b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx @@ -30,13 +30,18 @@ For those seeking other scenarios or fine-grain customisation [Weave GitOps Ente ### Prerequisites +:::warning Required Permissions +A Platform Engineer running the boostrap command requires to have both **cluster admin** permissions on the Management Cluster and **push** permissions to the Git repository. +::: + Before you start make sure the following requirements are met: -- [ ] **Management Cluster**: a Kubernetes cluster with a Kubeconfig that has Admin permissions to be able to create resources. +- [ ] **Management Cluster**: a Kubernetes cluster with a Kubeconfig with cluster admin permissions to be able to create resources. +- [ ] **Git Repository with SSH access**: the Git configuration repo to be used by Flux and Weave GitOps. - [ ] **Flux CLI**: is [installed](https://fluxcd.io/flux/installation/#install-the-flux-cli) locally. It will be used for reconciling Flux resources. -- [ ] **Weave GitOps Enterprise Entitlements** are installed in the management cluster. Contact [Sales](/help-and-support/) for help on getting them. +- [ ] **Weave GitOps Enterprise Entitlements** are installed in the Management Cluster. Contact [Sales](/help-and-support/) for help on getting them. -#### Install `gitops-ee` CLI (> v0.35) +### Install `gitops-ee` CLI Weave GitOps Enterprise Bootstrap functionality is available on Weave GitOps Enterprise CLI starting from version v0.35. If you haven't already, please install the latest `gitops-ee` CLI using this command. @@ -44,7 +49,7 @@ Weave GitOps Enterprise Bootstrap functionality is available on Weave GitOps Ent brew install weaveworks/tap/gitops-ee ``` -#### Bootstrap Weave GitOps Enterprise +### Bootstrap Weave GitOps Enterprise Please use the following command to start the installation wizard of Weave GitOps Enterprise. @@ -65,13 +70,12 @@ Please use the following command to start the installation wizard of Weave GitOp ```bash gitops bootstrap \ --kubeconfig=$HOME/.kube/config \ - --private-key=$HOME/.ssh/id_rsa \ - --private-key-password="" \ + --private-key=$HOME/.ssh/id_rsa --private-key-password="" \ --version="0.35.0" \ --domain-type="localhost" \ - --password="admin123" \ - --repo-url="ssh://git@github.com/my-org-name/my-repo-name" \ - --branch="main" \ + --password="admin123" \ + --repo-url="ssh://git@github.com/my-org-name/my-repo-name" \ + --branch="main" \ --repo-path="clusters/my-cluster" ``` For more information about the CLI configurations, check the below sections [here](#cli-configurations) @@ -87,7 +91,7 @@ Please use the following command to start the installation wizard of Weave GitOp `gitops-ee bootstrap` is a workflow that will take you through the following stages: 1. [Verify Flux](#verifying-flux): verify Flux installation on the Management cluster. -2. (Optional) [Bootstrap Flux](#bootstrap-flux): bootstrap flux in case flux not found. +2. (Optional) [Bootstrap Flux](#bootstrap-flux): bootstrap Flux in case is not found. 3. [Verify Entitlement](#verifying-entitlement): verify the Entitlements secret content (username, password, entitlement). 4. [Configure Git Access](#configure-git-access): configure the access to your configuration repo. 5. [Select WGE version](#selecting-wge-version): from the latest 3 available releases. @@ -98,14 +102,14 @@ Please use the following command to start the installation wizard of Weave GitOp #### Verify Flux -Weave GitOps Enterprise runs on top of flux, the bootstrap CLI will check if flux is installed on the management cluster, and it is able to reconcile flux components properly. -If flux is installed, but doesn't have a valid installation, the bootstrap CLI will terminate pending the fix or uninstall of current flux installation. +Weave GitOps Enterprise runs on top of Flux, the bootstrap CLI will check if Flux is installed on the management cluster, and it will verify that it has the right version with valid git repository setup, and it is able to reconcile Flux components properly. +If Flux is installed, but doesn't have a valid installation, the bootstrap CLI will terminate pending the fix or uninstall of current Flux installation. #### Bootstrap Flux -After verifying fkux installation if flux was not found you will have the ability to bootstrap flux with the [generic way](https://fluxcd.io/flux/installation/bootstrap/generic-git-server/), you will be prompted to provide your repository url, repository branch and path for your cluster. +After verifying Flux installation if Flux was not found you will have the ability to bootstrap Flux with the [generic way](https://fluxcd.io/flux/installation/bootstrap/generic-git-server/), you will be prompted to provide your repository url, repository branch and path for your cluster. Then based on your repo url if it's a ssh or https you will be prompted to provide your private key path & private key password or username & password/token. -After getting the right info regarding your repo, flux will start to bootstrap and reconcile your repo. +After getting the right info regarding your repo, Flux will start to bootstrap and reconcile your repo. #### Verify Entitlement @@ -164,8 +168,8 @@ Please don't forget to add a new static-client on your OIDC provider settings wi - `-c`, `--private-key-password`: Private key password. If the private key is encrypted using password - `-u`, `--username`: Dashboard admin username - `-v`, `--version`: Weave GitOps Enterprise version to install -- `--repo-url`: Git repo url for your flux repository +- `--repo-url`: Git repo url for your Flux repository - `--git-username`: Git username which contains your repository -- `--gitPassword`: Git password/token to give flux the accessiblity to be able to reconcile the repo -- `-b`, `--branch`: Git branch for your flux repository -- `-r`, `--repo-path`: Git path for your flux repository (example: clusters/my-cluster) +- `--gitPassword`: Git password/token to give Flux the accessiblity to be able to reconcile the repo +- `-b`, `--branch`: Git branch for your Flux repository +- `-r`, `--repo-path`: Git path for your Flux repository (example: clusters/my-cluster) From ebd3d17804dec4e0f346418e0257aa04aef7efc2 Mon Sep 17 00:00:00 2001 From: Eneko Fernandez Date: Thu, 16 Nov 2023 17:05:34 +0000 Subject: [PATCH 2/3] some suggestions while reading the docs --- .../enterprise/getting-started/install-enterprise-cli.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx index 7b30d20634..a0d432381c 100644 --- a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx +++ b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx @@ -107,9 +107,9 @@ If Flux is installed, but doesn't have a valid installation, the bootstrap CLI w #### Bootstrap Flux -After verifying Flux installation if Flux was not found you will have the ability to bootstrap Flux with the [generic way](https://fluxcd.io/flux/installation/bootstrap/generic-git-server/), you will be prompted to provide your repository url, repository branch and path for your cluster. -Then based on your repo url if it's a ssh or https you will be prompted to provide your private key path & private key password or username & password/token. -After getting the right info regarding your repo, Flux will start to bootstrap and reconcile your repo. +If Flux is not found in the Management Cluster, you have the ability to bootstrap it with the [Generic Git](https://fluxcd.io/flux/installation/bootstrap/generic-git-server/). +You will be prompted to provide: `repository url`, `repository branch` and `path` to reconcile. Based on your `repository url` authentication credentials will be requested. +For SSH, `private key path` & `private key password`. For HTTPS, `username` and `password`. After getting the right info regarding your repo, Flux will start to bootstrap and reconcile your repo. #### Verify Entitlement From a49e026e4a69ef4fef602ff479a59fe1f3d04ba8 Mon Sep 17 00:00:00 2001 From: Eneko Fernandez Date: Tue, 21 Nov 2023 09:27:19 +0000 Subject: [PATCH 3/3] moving from id_rsa to id_ed25519 in examples --- .../docs/enterprise/getting-started/install-enterprise-cli.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx index a0d432381c..0023952bbd 100644 --- a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx +++ b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx @@ -70,7 +70,7 @@ Please use the following command to start the installation wizard of Weave GitOp ```bash gitops bootstrap \ --kubeconfig=$HOME/.kube/config \ - --private-key=$HOME/.ssh/id_rsa --private-key-password="" \ + --private-key=$HOME/.ssh/id_ed25519 --private-key-password="" \ --version="0.35.0" \ --domain-type="localhost" \ --password="admin123" \