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.

Sign up for GitHub

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

Add CLI bootstrap flux documentation #4136

Merged
merged 6 commits into from
Nov 21, 2023
Merged

Add CLI bootstrap flux documentation #4136

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
170c236
Add cli bootstrap flux docs
Samra10 Nov 16, 2023
29859f9
fix cli flux bootstrap docs
Samra10 Nov 20, 2023
622d43b
Merge branch 'main' into 3619-cli-bootstrap-flux-docs
Samra10 Nov 20, 2023
631b46c
added docs suggestions while reviewing (#4137)
enekofb Nov 21, 2023
a23ea35
backporting docs to v0.36.0 so users in that version could have up to…
enekofb Nov 21, 2023
f026bdc
Merge branch 'main' into 3619-cli-bootstrap-flux-docs
Samra10 Nov 21, 2023
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
52 changes: 35 additions & 17 deletions website/docs/enterprise/getting-started/install-enterprise-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,26 @@ 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.
- [ ] **Git Repository with SSH access**: this is the configuration repo that WeaveGitOps will use to sync configuration manifests from.
- [ ] **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.
- [ ] **Flux Bootstrapped** in your Management cluster via ssh. See [Flux Bootstrap](https://fluxcd.io/flux/installation/bootstrap/generic-git-server/) for more info.
- [ ] **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.

```bash
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.

Expand All @@ -67,10 +70,13 @@ 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"
--password="admin123" \
--repo-url="ssh://git@github.com/my-org-name/my-repo-name" \
--branch="main" \
--repo-path="clusters/my-cluster"
Copy link
Contributor

Choose a reason for hiding this comment

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

have you tested whether you could bootstrap with this command?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, I've tested it with the same command and everything went well
image

Copy link
Contributor

Choose a reason for hiding this comment

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

cool, i guess i meant before without the \ that i dont think it would work.

➜✗  gitops bootstrap \                                                                            
    --kubeconfig=$HOME/.kube/config \
    --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" \
    --repo-path="clusters/my-cluster"
► creating client to cluster
✔ created client to cluster: https://127.0.0.1:52179
◎ checking flux
► verifying flux installation
✔ flux is installed

```
For more information about the CLI configurations, check the below sections [here](#cli-configurations)

Expand All @@ -85,18 +91,25 @@ 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. [Verify Entitlement](#verifying-entitlement): verify the Entitlements secret content (username, password, entitlement).
3. [Configure Git Access](#configure-git-access): configure the access to your configuration repo.
4. [Select WGE version](#selecting-wge-version): from the latest 3 available releases.
5. [Create Cluster User](#create-cluster-user): create a Secret with the username and password for the emergency cluster user.
6. [Configure Dashboard Access](#configure-dashboard-access): choose between 2 methods to access the dashboard either local or external.
7. [Access the dashboard](#access-the-dashboard): via the link from the installation success message.
8. (Optional) [Configure OIDC](#configure-oidc): to enable login to dashboard via OIDC providers.
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).
Copy link
Contributor

Choose a reason for hiding this comment

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

it feels odd that we could be doing a mutation in the cluster like installing flux without first verifying entitlements (given that is a pre-requirement). how do you guys feel about this ( cc @MostafaMegahid @waleedhammam )

Copy link
Contributor

Choose a reason for hiding this comment

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

i think when we discussed it before, there was a dependency as the entitlement lies in flux-system namespace

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I mean that given we have verifyXX as step, those seem better to come first before any action, as they are pre-conditions that we need to meet or we would drop. if we are in the scenario of dropping cause pre-condition is not met, you dont want to have done any change in the users environment

  • verifies first then
  • flux
Screenshot 2023-11-21 at 08 18 21

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.
6. [Create Cluster User](#create-cluster-user): create a Secret with the username and password for the emergency cluster user.
7. [Configure Dashboard Access](#configure-dashboard-access): choose between 2 methods to access the dashboard either local or external.
8. [Access the dashboard](#access-the-dashboard): via the link from the installation success message.
9. (Optional) [Configure OIDC](#configure-oidc): to enable login to dashboard via OIDC providers.

#### 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 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.
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

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

Expand Down Expand Up @@ -155,3 +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
- `--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)
Loading