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

adding export documentation to bootstrapping command #4163

Merged
merged 1 commit into from
Dec 11, 2023
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,22 @@ You could install Weave GitOps Enterprise via `gitops-ee bootstrap` CLI command
1. **Day 0**: you want to get started quickly for discovery with the less knowledge possible.
2. **Day 1**: you have done discovery and want to set it up in your organisation.

Each scenario is supported by an operation modes:
Each scenario is supported by an operation mode:

1. **Interactive:** guides you step-by-step through the process until Weave GitOps Enterprise is up and running.
2. **Non-interactive:** for your automated workflows where you are already familiar with install process and have the configuration.


For those seeking other scenarios or fine-grain customisation [Weave GitOps Enterprise manual install](../install-enterprise) would be the recommended.

## Getting Started

### 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.
:::warning Write Modes & Permissions
Bootstrapping requires you to have both **cluster admin** permissions on the Management Cluster and **push** permissions to the Git repository to write the generated resources.

In case you want just to generate the manifests but don't apply them, use the `--export` flag.
:::

Before you start make sure the following requirements are met:
Expand Down Expand Up @@ -123,7 +126,7 @@ To get the entitlement secret please contact *sales@weave.works*, then apply it

In order for `gitops-ee bootstrap` to push WGE resources to the management cluster's git repository, you will be prompted to provide the private key used to access your repo via ssh. If the private key is encrypted, you will also be asked to provide the private key password.
:::info
Disclaimer: The bootstrap CLI will ONLY use the private key to push WGE resources to your repo, and won't use it in any other way that can comprimise your repo or clusters security.
Disclaimer: The bootstrap CLI will ONLY use the private key to push WGE resources to your repo, and won't use it in any other way that can compromise your repo or clusters security.
:::

#### Select WGE version
Expand Down Expand Up @@ -164,7 +167,7 @@ The controllers will be installed with the default values. To customize controll

#### (Optional) Configure OIDC

OIDC configuration will enable you to login with OIDC provider beside, or instead of the admin credentials. Afte the installation is complete, you will be prompt if you want to configure OIDC access. If you don't want to set it up right away, you can do it later by running `gitops-ee bootstrap auth --type=oidc` command.
OIDC configuration will enable you to login with OIDC provider beside, or instead of the admin credentials. After the installation is complete, you will be prompt if you want to configure OIDC access. If you don't want to set it up right away, you can do it later by running `gitops-ee bootstrap auth --type=oidc` command.

To configure OIDC access, you will be asked to provide the following values:
`DiscoveryUrl` this will verify that OIDC is accessible and get the issuerUrl from the OIDC settings.
Expand All @@ -187,6 +190,7 @@ After installation is successful. The CLI will print out the URL where you can a
- ` ` `--client-secret` OIDC client secret
- ` ` `--components-extra` extra components to be installed from (policy-agent, tf-controller)
- ` ` `--discovery-url` OIDC discovery URL
- ` ` `--export` write to stdout the bootstrapping manifests without writing in the cluster or Git. It requires Flux to be bootstrapped.
- ` ` `--git-password` git password/token used in https authentication type
- ` ` `--git-username` git username used in https authentication type
- `-h`, `--help` help for bootstrap
Expand Down
Loading