docs: Add a dedicated Enterprise page

Or I guess bring it back since I feel it existed before? The purpose of this page is to highlight the additional features offered by enterprise. It also gives us a place to slot the confusing `Releases` tab under. Also: - Jazz up the intro and install pages, making the differences between tiers very clear and adding a bit of colour to break up the text. - Add some missing `enterprise` tags.
weaveworks · Feb 1, 2023 · 4797853 · 4797853
1 parent 7d1d438
commit 4797853
Show file tree

Hide file tree

Showing 33 changed files with 308 additions and 159 deletions.
diff --git a/website/docs/_components/TierLabel.jsx b/website/docs/_components/TierLabel.jsx
@@ -11,7 +11,7 @@ const containerStyle = {
 export default function TierLabel({ tiers }) {
   return (
     <Link
-      title={`This feature is a available on ${tiers}`}
+      title={`This feature is a available on ${tiers}.`}
       style={containerStyle}
     >
       {tiers}

diff --git a/website/docs/cluster-management/add-applications.mdx b/website/docs/cluster-management/add-applications.mdx
@@ -5,7 +5,7 @@ hide_title: true
 
 import TierLabel from "../\_components/TierLabel";
 
-# Add Applications <TierLabel tiers="enterprise" />
+# Add Applications <TierLabel tiers="Enterprise" />
 
 It is always useful to be able to install software packages to bootstrapped cluster. Weave GitOps Enterprise enables this by adding applications to target cluster through the UI by adding a kustomization or a helmrelease. Here is how we can do that:
 

diff --git a/website/docs/cluster-management/deleting-a-cluster.mdx b/website/docs/cluster-management/deleting-a-cluster.mdx
@@ -5,7 +5,7 @@ hide_title: true
 
 import TierLabel from "../_components/TierLabel";
 
-# Deleting a Cluster <TierLabel tiers="enterprise" />
+# Deleting a Cluster <TierLabel tiers="Enterprise" />
 
 ### How to: delete a cluster using UI
 

diff --git a/website/docs/cluster-management/gitrepo-selection.mdx b/website/docs/cluster-management/gitrepo-selection.mdx
@@ -1,4 +1,10 @@
-# Git repositories and resources
+---
+title: Git Repositories and Resources
+---
+
+import TierLabel from "../_components/TierLabel";
+
+# Git Repositories and Resources <TierLabel tiers="Enterprise" />
 
 During the pull request creation, to authenticate using Git, you will need to select the git repository where the pull request will be created.  
 

diff --git a/website/docs/cluster-management/managing-existing-clusters.mdx b/website/docs/cluster-management/managing-existing-clusters.mdx
@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
 
 import TierLabel from "../_components/TierLabel";
 
-# Managing existing clusters <TierLabel tiers="enterprise" />
+# Managing existing clusters <TierLabel tiers="Enterprise" />
 
 ### Managing non-capi clusters {#how-to-connect-a-cluster}
 

diff --git a/website/docs/cluster-management/profiles.mdx b/website/docs/cluster-management/profiles.mdx
@@ -5,7 +5,7 @@ hide_title: true
 
 import TierLabel from "../_components/TierLabel";
 
-# Profiles <TierLabel tiers="enterprise" />
+# Profiles <TierLabel tiers="Enterprise" />
 
 :::note BEFORE YOU START
 The following instructions require you to make minor changes to the content of your own hosted Helm repository.

diff --git a/website/docs/cluster-management/provider-identities.mdx b/website/docs/cluster-management/provider-identities.mdx
@@ -5,7 +5,7 @@ hide_title: true
 
 import TierLabel from "../_components/TierLabel";
 
-# CAPI Provider Identities <TierLabel tiers="enterprise" />
+# CAPI Provider Identities <TierLabel tiers="Enterprise" />
 
 ## Multi-tenancy
 

diff --git a/website/docs/configuration/user-permissions.mdx b/website/docs/configuration/user-permissions.mdx
@@ -93,7 +93,7 @@ The primary method by which Flux communicates the status of itself is by events,
 these will show when reconciliations start and stop, whether they're successful
 and information as to why they're not.
 
-## Weave GitOps Enterprise <TierLabel tiers="enterprise" />
+## Weave GitOps Enterprise <TierLabel tiers="Enterprise" />
 
 Weave GitOps Enterprise extends Weave GitOps OSS by adding more roles. These roles may need to be extended further in order to support certain use cases. Some of the most common use cases are described below.
 

diff --git a/website/docs/getting-started.mdx b/website/docs/getting-started.mdx
@@ -7,7 +7,13 @@ hide_title: true
 
 This hands-on guide will introduce you to the basics of the GitOps Dashboard web UI, to help you understand the state of your system, before deploying a new application to your cluster. It is adapted from this guide - [Flux - Getting Started](https://fluxcd.io/docs/get-started/).
 
-If you haven't already, be sure to check out our [introduction](./intro.md) to Weave GitOps and our [installation docs](./installation/index.mdx).
+If you haven't already, be sure to check out our [introduction](./intro.mdx) to Weave GitOps and our [installation docs](./installation/index.mdx).
+
+## TL;DR: Highlights
+
+- **Applications view** - allows you to quickly understand the state of your deployments across a cluster at a glance. It shows summary information from `kustomization` and `helmrelease` objects.
+- **Sources view** - shows the status of resources which are synchronizing content from where you have declared the desired state of your system, for example Git repositories. This shows summary information from `gitrepository`, `helmrepository` and `bucket` objects.
+- **Flux Runtime view** - provides status on the GitOps engine continuously reconciling your desired and live state. It shows your installed GitOps Toolkit Controllers and their version.
 
 ## Part 1 - Weave GitOps overview
 

diff --git a/website/docs/gitops-templates/templates.mdx b/website/docs/gitops-templates/templates.mdx
@@ -5,7 +5,7 @@ hide_title: true
 
 import TierLabel from "../_components/TierLabel";
 
-# Why GitOps templates <TierLabel tiers="enterprise" />
+# Why GitOps templates <TierLabel tiers="Enterprise" />
 GitOpsTemplates enables Application Developers to self-service components and services using Weave GitOps. 
 Turning knowledge into a library that can be self-served.
 

diff --git a/website/docs/guides/delivery.mdx b/website/docs/guides/delivery.mdx
@@ -5,7 +5,7 @@ hide_title: true
 
 import TierLabel from "../_components/TierLabel";
 
-# Progressive delivery using Flagger <TierLabel tiers="enterprise" />
+# Progressive delivery using Flagger <TierLabel tiers="Enterprise" />
 
 [Flagger](https://docs.flagger.app/) is a progressive delivery operator for Kubernetes. It is
 designed to reduce risks when introducing new software versions and to improve time to delivery

diff --git a/website/docs/guides/deploying-capa.mdx b/website/docs/guides/deploying-capa.mdx
@@ -10,7 +10,7 @@ import TierLabel from "../_components/TierLabel";
 import CodeBlock from "@theme/CodeBlock";
 import BrowserOnly from "@docusaurus/BrowserOnly";
 
-# Deploying CAPA with EKS <TierLabel tiers="enterprise" />
+# Deploying CAPA with EKS <TierLabel tiers="Enterprise" />
 
 ## Creating your first CAPA Cluster
 

diff --git a/website/docs/guides/using-terraform-templates.mdx b/website/docs/guides/using-terraform-templates.mdx
@@ -4,7 +4,7 @@ title: Using Terraform templates
 
 import TierLabel from "../_components/TierLabel";
 
-# Using Terraform templates <TierLabel tiers="enterprise" />
+# Using Terraform templates <TierLabel tiers="Enterprise" />
 
 This guide will show you how to use a template to create a Terraform resource in Weave GitOps Enterprise.
 

diff --git a/website/docs/installation/weave-gitops-enterprise/airgap.mdx b/website/docs/installation/weave-gitops-enterprise/airgap.mdx
@@ -5,7 +5,9 @@ toc_max_heading_level: 4
 pagination_next: "getting-started"
 ---
 
-# Install in Airgap Environments
+import TierLabel from "../../_components/TierLabel";
+
+# Install in Airgap Environments <TierLabel tiers="Enterprise" />
 
 From [wikipedia](https://en.wikipedia.org/wiki/Air_gap_(networking))
 
@@ -539,4 +541,4 @@ images:
   infrastructure-microvm:
     repository: localhost:5001/ghcr.io/weaveworks-liquidmetal
 ```
-Then execute `make clusterctl-init` to init capi using your private registry.
+Then execute `make clusterctl-init` to init capi using your private registry.
diff --git a/website/docs/installation/weave-gitops-enterprise/index.mdx b/website/docs/installation/weave-gitops-enterprise/index.mdx
@@ -9,21 +9,15 @@ import TabItem from "@theme/TabItem";
 import TierLabel from "../../_components/TierLabel";
 import CurlCodeBlock from "../../_components/CurlCodeBlock";
 
-## Installing Weave GitOps Enterprise<TierLabel tiers="enterprise" />
+## Installing Weave GitOps Enterprise<TierLabel tiers="Enterprise" />
 
-Weave GitOps Enterprise (WGE) provides ops teams with an easy way to assess the
-health of multiple clusters in a single place. It shows cluster information such as
-Kubernetes version and number of nodes and provides details about the GitOps operations
-on those clusters, such as Git repositories and recent commits. Additionally, it
-aggregates Prometheus alerts to assist with troubleshooting.
+:::info
+To purchase entitlement to Weave GitOps Enterprise Edition please contact [[email protected]](mailto:[email protected])
 
-To purchase entitlement to Weave GitOps Enterprise please contact [[email protected]](mailto:[email protected])
-
-:::note 
-There is no need to install Weave GitOps (OSS) before installing Weave GitOps Enterprise
+For more information about WGEE, see the [Enterprise feature page](../../intro-ee.mdx).
 :::
 
-To install Weave GitOps Enterprise
+Follow the instructions on this page to:
 
 import TOCInline from "@theme/TOCInline";
 
@@ -32,6 +26,10 @@ import TOCInline from "@theme/TOCInline";
            return trimStart.slice(0, trimStart.findIndex((node) => node.level == '2'));
            })()} />
 
+:::tip
+There is no need to install Weave GitOps (OSS) before installing Weave GitOps Enterprise
+:::
+
 ### 1. Set up a Management Cluster with `flux`
 
 To get you started in this document we'll cover:
@@ -324,7 +322,7 @@ kubectl create secret generic cluster-user-auth \
   --from-literal=password='$2a$.......'
 ```
 
-### Install CLI
+### 7. Install the CLI
 Install the Weave GitOps Enterprise CLI tool.
 You can use brew or curl
 

diff --git a/website/docs/installation/weave-gitops.mdx b/website/docs/installation/weave-gitops.mdx
@@ -4,25 +4,25 @@ hide_title: true
 pagination_next: "getting-started"
 ---
 
-## Installing Weave GitOps
+## Installing Weave GitOps on your Cluster
 
-### Before you begin
-
-We will provide a complete walk-through of getting Flux installed and Weave GitOps configured. However, if you have:
-- an existing cluster bootstrapped Flux version >= 0.32.0 🎉
-- followed our [installation](./index.mdx) doc to configure access to the Weave GitOps dashboard then install Weave GitOps 👏
+:::tip
+These are the instructions to install the OSS tier GitOps. To install Enterprise
+GitOps, follow the instructions [here][ee-install].
+:::
 
-Then you can skip ahead to [the Weave GitOps overview](../getting-started.mdx#part-1---weave-gitops-overview) 🏃
-but note ⚠️ you may need to alter commands where we are committing files to GitHub ⚠️.
+### Before you begin
 
 To follow along, you will need the following:
-- A Kubernetes cluster - such as [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/).
-- A [GitHub](https://github.com) account and [personal access token with repo permissions](https://help.github.com/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
-- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl).
+- A Kubernetes cluster - such as [Kind][kind]
+- A [GitHub][github] account and [personal access token with repo permissions][pat]
+- [kubectl][kubectl]
 
-#### Install Flux
+### Install Flux
 
-Weave GitOps is an extension to Flux and therefore requires that Flux 0.32 or later has already been installed on your Kubernetes cluster. Full documentation is available at: [https://fluxcd.io/docs/installation/](https://fluxcd.io/docs/installation/).
+Weave GitOps is an extension to Flux and therefore requires that Flux 0.32 or
+later has already been installed on your Kubernetes cluster. Full documentation
+is available [here][fl-install].
 
 This version of Weave GitOps is tested against the following Flux releases:
 * 0.32
@@ -31,13 +31,20 @@ This version of Weave GitOps is tested against the following Flux releases:
 * 0.35
 * 0.36
 
+In this section we are going to do the following:
+
+- Create a git repository `fleet-infra` in your Git account
+- Add Flux component manifests to the repository
+- Deploy Flux Components to your Kubernetes Cluster
+- Configure Flux components to track the path `./clusters/my-cluster/` in the repository
+
 1. Install the flux CLI
 
    ```
    brew install fluxcd/tap/flux
    ```
 
-   For other installation methods, see the relevant [Flux documentation](https://fluxcd.io/docs/installation/#install-the-flux-cli).
+   For other installation methods, see the relevant [Flux documentation][fl-install].
 
 1. Export your credentials
 
@@ -70,20 +77,14 @@ This version of Weave GitOps is tested against the following Flux releases:
      --personal
    ```
 
-Full installation documentation including how to work with other Git providers is available [here](https://fluxcd.io/docs/installation/).
-
-The bootstrap command above does the following:
+	:::info
+	Full installation documentation including how to work with other Git providers is available [here][fl-install].
+	:::
 
-- Create a git repository fleet-infra on your GitHub account
-- Add Flux component manifests to the repository
-- Deploy Flux Components to your Kubernetes Cluster
-- Configure Flux components to track the path /clusters/my-cluster/ in the repository
-
-### Install Weave GitOps
+1. If you navigate to your Git provider, you will see that the `fleet-infra`
+	repository has been created.
 
-For this guide we will use the cluster user, for complete documentation including how to configure an OIDC provider see the documentation [here](../configuration/securing-access-to-the-dashboard.mdx).
-
-#### gitops CLI
+### Install the `gitops` CLI
 
 Weave GitOps includes a command-line interface to help users create and manage resources.
 
@@ -118,7 +119,15 @@ brew install weaveworks/tap/gitops
 </TabItem>
 </Tabs>
 
-### Deploying Weave GitOps
+### Deploy Weave GitOps
+
+In this section we will do the following:
+
+- Use the GitOps CLI tool to generate [`HelmRelease`][helm-rel] and [`HelmRepository`][helm-repo] objects.
+- Create some login credentials to access the dashboard. This is a simple but **insecure**
+  method of protecting and accessing your GitOps dashboard.
+- Commit the generated yamls to our `fleet-infra` repo.
+- Observe as they are synced to the cluster.
 
 1. Clone your git repository where Flux has been bootstrapped.
 
@@ -136,11 +145,13 @@ brew install weaveworks/tap/gitops
      --export > ./clusters/my-cluster/weave-gitops-dashboard.yaml
    ```
 
-:::warning
-This command stores a hash of a password.  While this is relatively safe for demo and testing purposes it is recommend that you look at more secure methods of storing secrets (such as [Flux's SOPS integration](https://fluxcd.io/docs/guides/mozilla-sops/)) for production systems.
+	:::warning
+	This command stores a hash of a password.  While this is relatively safe for demo
+	and testing purposes it is recommend that you look at more secure methods of storing secrets
+	(such as [Flux's SOPS integration][sops]) for production systems.
 
-More guidance and alternative login methods can be found in [Securing access to the dashboard](../../configuration/securing-access-to-the-dashboard).
-:::
+	More guidance and alternative login methods can be found in [Securing access to the dashboard][dash-access].
+	:::
 
 1. Commit and push the `weave-gitops-dashboard.yaml` to the `fleet-infra` repository
 
@@ -166,11 +177,23 @@ More guidance and alternative login methods can be found in [Securing access to
    ww-gitops-weave-gitops-86b645c9c6-k9ftg    1/1     Running   0          5m
    ```
 
-:::info
-There's many other things you can configure in the weave gitops helm chart. For a reference, see [our value file reference](../references/helm-reference.md).
-:::
-
+	:::tip
+	There are many other things you can configure in the Weave GitOps Helm Chart.
+	For a reference, see [our value file reference](../references/helm-reference.md).
+	:::
 
 ## Next steps
 
-In our following [Get Started document](../getting-started.mdx), we will walk you through logging into the GitOps Dashboard and deploying an application.
+In the following [Get Started document](../getting-started.mdx), we will walk you
+through logging into the GitOps Dashboard and deploying an application.
+
+[ee-install]: ../weave-gitops-enterprise
+[kind]: https://kind.sigs.k8s.io/docs/user/quick-start/
+[github]: https://github.com
+[pat]: https://help.github.com/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
+[kubectl]: https://kubernetes.io/docs/tasks/tools/#kubectl
+[fl-install]: https://fluxcd.io/docs/installation/
+[dash-access]: ../configuration/securing-access-to-the-dashboard.mdx
+[sops]: https://fluxcd.io/docs/guides/mozilla-sops/
+[helm-repo]: https://fluxcd.io/flux/components/source/helmrepositories/#writing-a-helmrepository-spec
+[helm-rel]: https://fluxcd.io/flux/components/helm/helmreleases/