-
Notifications
You must be signed in to change notification settings - Fork 153
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Eneko Fernandez <[email protected]>
- Loading branch information
Showing
7 changed files
with
45 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,26 +2,20 @@ | |
| title: Manually | ||
| hide_title: false | ||
| pagination_prev: enterprise/getting-started/install-enterprise-getting-started | ||
| pagination_next: enterprise/getting-started/install-enterprise-getting-started-onboard | ||
| pagination_next: enterprise/getting-started/install-enterprise-getting-started-harden | ||
| toc_max_heading_level: 4 | ||
| --- | ||
|
|
||
| import Tabs from "@theme/Tabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
| import TierLabel from "@site/docs/_components/TierLabel"; | ||
| import AlphaWarning from "../../_components/_alpha_warning.mdx"; | ||
| import CurlCodeBlock from "../../_components/CurlCodeBlock"; | ||
| import oauthBitbucket from '/img/oauth-bitbucket.png'; | ||
| import oauthAzureDevOps from '/img/oauth-azure-devops.png'; | ||
| import oauthAzureDevOpsSuccess from '/img/oauth-azure-devops-success.png'; | ||
|
|
||
| # Getting Started Manually | ||
|
|
||
| This guide will walk you through to manual getting started [bootstrapping](../install-enterprise-getting-started/#bootstrapping) route for Weave GitOps Enterprise. | ||
|
|
||
| :::caution This guide aims to easy discovery or day-0 experiences. | ||
| :::info What to expect | ||
| You are a Platform Engineer in charge of discovering or setting up Weave GitOps Enterprise for your organisation. | ||
|
|
||
| Ensure you complete the [rest of the journeys](../install-enterprise-getting-started/) if you aim to onboard other Platform Engineers or Developers. | ||
| This guide will walk you through to manual getting started [bootstrapping](../install-enterprise-getting-started/#bootstrapping) route for Weave GitOps Enterprise. | ||
| ::: | ||
|
|
||
| ## Bootstrap Flux | ||
|
|
@@ -37,15 +31,7 @@ flux bootstrap git --url="https://example.com/repository.git" --"password=passwo | |
| flux bootstrap git --url="ssh://[email protected]/repository.git" --private-key-file="path/to/private.key" --password="password" --path="clusters/my-cluster" | ||
| ``` | ||
|
|
||
| ## Entitlements | ||
|
|
||
| Weave GitOps Enterprise Entitlement is your obtained license to use our product. The Entitlements file is a Kubernetes secret that contains your licence. | ||
| To get the entitlement secret please contact *[email protected]*, then apply it on your management cluster with the name `weave-gitops-enterprise-credentials` under `flux-system` namespace. | ||
|
|
||
| ```bash | ||
| kubectl apply -n flux-system -f entitlements.yaml | ||
| ``` | ||
| ## Authentication | ||
| ## Configure Authentication | ||
|
|
||
| There are two supported authentication methods for Weave GitOps Enterprise: | ||
|
|
||
|
|
@@ -92,7 +78,7 @@ Use these credentials to login as `ClusterUser` via the UI. | |
| Ensure your [authentication is fit for production](../install-enterprise-onboard-platform-engineers#authentication) before onboarding other Platform Engineers or Developers. | ||
| ::: | ||
|
|
||
| ## Authorization | ||
| ## Configure Authorization | ||
|
|
||
| Weave GitOps Enterprise works with standard [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) | ||
| to define what actions can a subject do-over the existing resources. Weave GitOps requires authorization for the following subjects: | ||
|
|
@@ -175,7 +161,7 @@ They are generated during Flux Bootstrapping. More information about Flux Author | |
| Ensure your [authorization is fit for production](../install-enterprise-onboard-platform-engineers#authorization) before onboarding other Platform Engineers or Developers. | ||
| ::: | ||
|
|
||
| ## Install WGE | ||
| ## Deploy the HelmRelease | ||
|
|
||
| We install Weave GitOps Enterprise via Flux Helm Release that you could deploy via the CLI or manually: | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| --- | ||
| title: Step 1 - Getting Started | ||
| hide_title: true | ||
| pagination_prev: enterprise/getting-started/intro-enterprise | ||
| pagination_next: enterprise/getting-started/install-enterprise-getting-started-onboard | ||
| pagination_prev: enterprise/getting-started/intro | ||
| pagination_next: enterprise/getting-started/install-enterprise-getting-started-harden | ||
| toc_max_heading_level: 4 | ||
| --- | ||
|
|
||
|
|
@@ -72,20 +72,10 @@ To get the entitlement secret please contact *[email protected]*, then apply it | |
| ``` | ||
| ## Bootstrapping | ||
|
|
||
| Bootstrapping is the workflow that installs Weave GitOps Enterprise in your environment by executing these stages: | ||
| Bootstrap Weave GitOps Enterprise in your environment by any of these methods: | ||
|
|
||
| 1. **Bootstrap Flux**: bootstrap Flux on your Management Cluster. | ||
| 2. **Entitlements**: verify your Entitlements. | ||
| 3. **Authentication**: configure how users authenticate. | ||
| 4. **Authorization**: configure what your users and other subjects can do. | ||
| 5. **Install WGE**: deploy Weave GitOps Enterprise via Flux Helm Release. | ||
| 6. **Access the dashboard**: access the application as you expect. | ||
| 7. **Extend WGE**: add other capabilities to support your Platform workflows. | ||
|
|
||
| Run the method that better match your expectations. | ||
|
|
||
| <Tabs groupId="flux bootstrap" defaultValue="cli-interactive"> | ||
| <TabItem value="cli-interactive" label="CLI Interactive"> | ||
| <Tabs groupId="bootstrap" defaultValue="cliInteractive"> | ||
| <TabItem value="cliInteractive" label="CLI Interactive"> | ||
|
|
||
| :::tip Recommended path if: | ||
|
|
||
|
|
@@ -101,7 +91,7 @@ You have limited knowledge about the product and / or want guidance step-by-step | |
|
|
||
| <AlphaWarning/> | ||
| </TabItem> | ||
| <TabItem value="cli-not-interactive" label="CLI Non Interactive"> | ||
| <TabItem value="cliNotInteractive" label="CLI Non Interactive"> | ||
|
|
||
| :::tip Recommended Path if: | ||
| You are already familiar with installing Weave GitOps Enterprise. You wan to leverage the CLI for consistency and automation. | ||
|
|
@@ -135,7 +125,12 @@ gitops bootstrap --silent \ | |
| You want to have full control on the process or your context cannot be handled via the CLI. | ||
| ::: | ||
|
|
||
| Continue to [Manual Bootstrapping](../install-enterprise-getting-started-manual) to guide you. | ||
| Execute the following tasks to manually bootstrap: | ||
|
|
||
| 1. [**Bootstrap Flux**](../install-enterprise-getting-started-manual/#bootstrap-flux) | ||
| 2. [**Configure Authentication**](../install-enterprise-getting-started-manual/#configure-authentication) | ||
| 3. [**Configure Authorization**](../install-enterprise-getting-started-manual/#configure-authorization) | ||
| 4. [**Deploy WGE HelmRelease**](../install-enterprise-getting-started-manual/#deploy-the-helmrelease) | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
@@ -159,5 +154,5 @@ Access your browser on [http://localhost:8000](http://localhost:8000) to see the | |
| ## Next Steps | ||
|
|
||
| You have bootstrapped Weave GitOps Enterprise and Flux on your Management Cluster. Continue to | ||
| [Step 2 - Onboarding](../install-enterprise-getting-started-onboard) to harden your environment | ||
| [Step 2 - Onboarding](../install-enterprise-getting-started-harden) to harden your environment | ||
| to onboard the rest of the team. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,33 +7,18 @@ import Link from "@docusaurus/Link"; | |
|
|
||
| # Weave GitOps Enterprise <TierLabel tiers="Enterprise" /> | ||
|
|
||
| :::tip Ready for more GitOps? | ||
| To purchase an entitlement to Weave GitOps Enterprise, please contact [[email protected]](mailto:[email protected]). | ||
| ::: | ||
|
|
||
| [Weave GitOps Enterprise](https://www.weave.works/product/enterprise-faq/) is a platform engineering solution that extends Kubernetes to manage the platform using the GitOps model. It is a developer friendly Kubernetes application platform for on-premise and cloud deployment and is additive to standard managed Kubernetes tools (e.g., OpenShift, Rancher, EKS, AKS, etc.). WGE offers streamlined operations, enhanced developer productivity, compliance and security, scalability, and growth, and provides trusted support and readiness for production. | ||
|
|
||
| - Continue to [Getting Started](#getting-started) to start your Weave GitOpps Enterprise journey. | ||
| - Reade more about [features](#feature-breakdown) or in [Weave GitOps Enterprise FAQ](https://www.weave.works/product/enterprise-faq/) for more information. | ||
|
|
||
| ## Install | ||
|
|
||
| You are a Platform Engineer who is in charge of discovering or setting up Weave GitOps Enterprise (WGE) for your organisation. | ||
| We propose you to tackle it in three days: | ||
|
|
||
| ### Step 1: Getting Started | ||
| :::tip Start onboarding | ||
|
|
||
| [**Get your environment setup**](../install-enterprise-getting-started) with limited knowledge about WGE. You want to do some initial discovery or to layout the foundations. | ||
| As a Platform Engineer, you bear the task of either exploring or establishing Weave GitOps Enterprise (WGE) | ||
| within your organization. We suggest that you onboard following these steps: | ||
|
|
||
| ### Step 2: Onboard the team | ||
|
|
||
| [**Onboard Platform Engineers**](../install-enterprise-onboard): you want to harden your setup to onboard other Platform Engineers. Other Platform Engineers setup any WGE capabilities for your devs. | ||
|
|
||
| [**Onboard Developers**](../install-enterprise-onboard): the platform capabilities have been setup and you ready to start onboard developers. | ||
|
|
||
| ### Day 2: Operate & Improve | ||
|
|
||
| - TBA | ||
| - [**Step 1 - Get Started**](../install-enterprise-getting-started) quickly with limited knowledge about WGE. This is your first action aimed at conducting preliminary exploration, or laying out the groundwork. | ||
| - [**Step 2 - Harden**](../install-enterprise-getting-started-harden) your setup and onboard to other Platform Engineers. | ||
| - [**Step 3 - Expand**](../install-enterprise-expand) what WGE can do with the rest of the Platform Engineering team. | ||
| - [**Step 4 - Onboard and Operate**](../install-enterprise-expand): onboard your Developers and operate the Platform. | ||
| ::: | ||
|
|
||
| ## Feature Breakdown | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters