diff --git a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx index 2462527f22..31747bb3f6 100644 --- a/website/docs/enterprise/getting-started/install-enterprise-cli.mdx +++ b/website/docs/enterprise/getting-started/install-enterprise-cli.mdx @@ -14,14 +14,21 @@ import TabItem from "@theme/TabItem"; -You could install Weave GitOps Enterprise `gitops-ee bootstrap` which streamlines the installation process. It has two main modes: +You could install Weave GitOps Enterprise via `gitops-ee bootstrap` CLI command which is suitable for two main scenarios: -1. `Interactive` or Wizard mode for guiding you step-by-step through the process until Weave GitOps Enterprise is up and running. Ideal for your first installation. -2. `Non-interactive` or automated mode where the process will be executed via configuration. Ideal for your automated workflows. +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. -For those seeking advanced customization, the flexibility to fine-tune [Weave GitOps Enterprise manual install](../install-enterprise) is also available. +Each scenario is supported by an operation modes: -## Prerequisites +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 Before you start make sure the following requirements are met: @@ -29,9 +36,7 @@ Before you start make sure the following requirements are met: - [ ] **Git Repository with SSH access**: this is the configuration repo that WeaveGitOps will use to sync configuration manifests from. - [ ] **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. - -## Getting Started +- [ ] **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) @@ -46,44 +51,36 @@ brew install weaveworks/tap/gitops-ee Please use the following command to start the installation wizard of Weave GitOps Enterprise. - - ```bash - - gitops-ee bootstrap - + gitops bootstrap ``` - The bootstrap wizard will take you step-by-step into configuring Weave GitOps Enterprise. To understand more about the CLI configurations experience, check the below sections [here](#cli-configurations). - You could run the bootstrap command in non-interactive mode by providing the required configurations as flags. The following gives you an example to get started that you could adapt to your own context ```bash - gitops-ee bootstrap \ - --kubeconfig="~/.kube/config" \ # (optional) Management cluster configuration. If not set default kubeconfig resolution is used. - --private-key="~/.ssh/id_rsa" --private-key-password="" \ # Git repository SSH configuration - --version="0.33.0" \ # version to install - --domain-type="localhost" \ # how to expose the dashboard - --username=wego-admin --password=admin123 \ # emergency user configuration - --discovery-url="" --client-id="weave-gitops-enterprise" --client-secret="changeme" \ # (optional) OIDC configuration + gitops bootstrap \ + --kubeconfig=$HOME/.kube/config \ + --private-key=$HOME/.ssh/id_rsa --private-key-password="" \ + --version="0.35.0" \ + --domain-type="localhost" \ + --password="admin123" ``` For more information about the CLI configurations, check the below sections [here](#cli-configurations) - ## Appendix -### Appendix I: Understanding `gitops-ee bootstrap` +### Understanding `gitops-ee bootstrap` `gitops-ee bootstrap` is a workflow that will take you through the following stages: @@ -148,7 +145,7 @@ To configure OIDC access, you will be asked to provide the following values: Please don't forget to add a new static-client on your OIDC provider settings with the redirectURI `your-domain/oauth2/callback` for example `http://localhost:3000/oauth2/callback` ::: -### Appendix II: CLI configurations +### CLI configurations - `--kube-config`: allows to choose the Kubeconfig for your cluster, default would be ~/.kube/config - `-d`, `--domain externaldns`: indicate the domain to use in case of using externaldns