From 217af411eaa928523e96fc1837bdf140763a77a8 Mon Sep 17 00:00:00 2001 From: Claudia Beresford Date: Wed, 1 Feb 2023 15:48:01 +0000 Subject: [PATCH] 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. --- website/docs/_components/TierLabel.jsx | 2 +- .../cluster-management/add-applications.mdx | 2 +- .../cluster-management/deleting-a-cluster.mdx | 2 +- .../cluster-management/gitrepo-selection.mdx | 8 +- .../managing-existing-clusters.mdx | 2 +- website/docs/cluster-management/profiles.mdx | 2 +- .../provider-identities.mdx | 2 +- .../docs/configuration/user-permissions.mdx | 2 +- website/docs/getting-started.mdx | 8 +- website/docs/gitops-templates/templates.mdx | 2 +- website/docs/guides/delivery.mdx | 2 +- website/docs/guides/deploying-capa.mdx | 2 +- .../docs/guides/using-terraform-templates.mdx | 2 +- .../weave-gitops-enterprise/airgap.mdx | 6 +- .../weave-gitops-enterprise/index.mdx | 22 ++--- website/docs/installation/weave-gitops.mdx | 95 +++++++++++------- website/docs/intro-ee.mdx | 69 +++++++++++++ website/docs/intro.md | 76 -------------- website/docs/intro.mdx | 98 +++++++++++++++++++ website/docs/pipelines/authorization.mdx | 4 +- website/docs/pipelines/getting-started.mdx | 2 +- website/docs/pipelines/pipeline-templates.mdx | 2 +- .../docs/pipelines/promoting-applications.mdx | 2 +- .../docs/pipelines/spec/v1alpha1/pipeline.mdx | 4 +- website/docs/policy/commit-time-checks.mdx | 2 +- website/docs/policy/configuration.mdx | 3 +- website/docs/policy/getting-started.mdx | 2 +- website/docs/policy/policy-configuration.mdx | 4 +- website/docs/policy/policy-set.mdx | 3 +- website/docs/policy/releases.mdx | 2 +- website/docs/policy/weave-policy-profile.mdx | 2 +- website/docs/releases.mdx | 4 +- website/sidebars.js | 28 +++++- 33 files changed, 309 insertions(+), 159 deletions(-) create mode 100644 website/docs/intro-ee.mdx delete mode 100644 website/docs/intro.md create mode 100644 website/docs/intro.mdx diff --git a/website/docs/_components/TierLabel.jsx b/website/docs/_components/TierLabel.jsx index 6fc104cc1f2..1bb36bdbafb 100644 --- a/website/docs/_components/TierLabel.jsx +++ b/website/docs/_components/TierLabel.jsx @@ -11,7 +11,7 @@ const containerStyle = { export default function TierLabel({ tiers }) { return ( {tiers} diff --git a/website/docs/cluster-management/add-applications.mdx b/website/docs/cluster-management/add-applications.mdx index 743c0faee9f..773cc0892e5 100644 --- 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 +# Add Applications 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 index 6d8a7e31fdb..6ca6bdff476 100644 --- 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 +# Deleting a Cluster ### 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 index d1f849de310..0d39ae7f5cb 100644 --- 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 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 index 6499409b2a2..695293152a6 100644 --- 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 +# Managing existing clusters ### 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 index 17b2e8f7e40..580910db77d 100644 --- 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 +# Profiles :::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 index 0a8f08377ec..9a3563a3514 100644 --- 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 +# CAPI Provider Identities ## Multi-tenancy diff --git a/website/docs/configuration/user-permissions.mdx b/website/docs/configuration/user-permissions.mdx index 5089a0ee4c1..d43dc7c089a 100644 --- 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 +## Weave GitOps 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 index 028524d476a..a5974a551a8 100644 --- 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 index 8bd08ad3415..8eca02c0b18 100644 --- 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 +# Why GitOps templates 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 index 13230f30d5c..2b9c676f176 100644 --- 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 +# Progressive delivery using Flagger [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 index e884051eb2d..41164e9ee7c 100644 --- 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 +# Deploying CAPA with EKS ## Creating your first CAPA Cluster diff --git a/website/docs/guides/using-terraform-templates.mdx b/website/docs/guides/using-terraform-templates.mdx index 0f782cf0481..f655a7ad21d 100644 --- 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 +# Using Terraform templates 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 index e3dfd73af1b..9ed40c443a8 100644 --- 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 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. \ No newline at end of file +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 index 486cd11a48c..8d52d042e43 100644 --- 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 +## Installing Weave GitOps 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 [sales@weave.works](mailto:sales@weave.works) -To purchase entitlement to Weave GitOps Enterprise please contact [sales@weave.works](mailto:sales@weave.works) - -:::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 index f01460e7739..3e11673aea8 100644 --- 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 -### 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/ diff --git a/website/docs/intro-ee.mdx b/website/docs/intro-ee.mdx new file mode 100644 index 00000000000..94a5c5868db --- /dev/null +++ b/website/docs/intro-ee.mdx @@ -0,0 +1,69 @@ +--- +title: Enterprise Edition +hide_title: true +--- +import TierLabel from "./_components/TierLabel"; +import Link from "@docusaurus/Link"; + +# Weave GitOps Enterprise Edition + +:::tip Ready for more GitOps? +To purchase entitlement to Weave GitOps Enterprise Edition please contact [sales@weave.works](mailto:sales@weave.works) +::: + +WGEE 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. + +If you have already purchased your entitlement, head to the [installation page](./installation/weave-gitops-enterprise/index.mdx). + +## Feature breakdown + +In addition to the features in the OSS edition, Weave GitOps Enterprise Edition +offers the following capabilities, taking your delivery from simple CD to IDP: + +### :boat: Cluster Fleet Management +Deploy the same application into many different clusters even across +cloud and hybrid environments, allowing change deployments across the fleet +via Git and Cluster API. + +### :closed_lock_with_key: Trusted Application Delivery +Add policy as code to GitOps pipelines and enforce security and compliance, +application resilience and coding standards from source to production. +Validate policy conformance at every step in the software delivery pipeline: +commit, build, deploy and run time. + +### :black_right_pointing_double_triangle_with_vertical_bar: Progressive Delivery +Deploy into production environments safely using canary, blue/green and A/B +strategies. Simple single file configuration defines success / rollback SLO +using observability metrics from Prometheus, Datadog, New Relic and others. + +### :infinity: CD Pipelines +Rollout new software from development to production. +Environment rollouts that work with your existing CI system. + +### :factory_worker::female-factory-worker: Team Workspaces +Allow DevOps teams to work seamlessly together with multi-tenancy. +Total RBAC control and policy enforcement with integration to enterprise IAM. + +### :point_up_2: Self-Service Templates and Profiles +Component profiles enable teams to deploy standard services quickly, +consistently and reliably. Teams can curate the profiles that are available +within their estate ensuring there is consistency everywhere. Using GitOps +it's easy to guarantee the latest, secure versions of any component are +deployed in all production systems. + +### :sparkling_heart: Health Status and Compliance Dashboards +Gain a single view of the health and state of the cluster and its workloads. +Monitor deployments and alert on policy violations across apps and clusters. + +### :compass: Kubernetes Anywhere +Reduce complexity with GitOps and install across all major target environments +including support for on-premise, edge, hybrid, and multi-cloud Kubernetes clusters + +### :bell: Critical 24/7 Support +Your business and workloads operate around the clock and so do we. +Our team operates 24/7 so whenever there’s a problem our experts are +there to help. Operate with confidence - we’ve got your back! diff --git a/website/docs/intro.md b/website/docs/intro.md deleted file mode 100644 index 6aed28da484..00000000000 --- a/website/docs/intro.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Introduction -sidebar_position: 0 -hide_title: true ---- -# Weave GitOps - -Weave GitOps is a powerful extension to [Flux](https://fluxcd.io), a leading GitOps engine and CNCF project. Weave GitOps provides insights into your application deployments, and makes continuous delivery with GitOps easier to adopt and scale across your teams. - -Its web UI surfaces key information to help application operators easily discover and resolve issues. The intuitive interface provides a guided experience to build understanding and simplify getting started for new users; they can easily discover the relationship between Flux objects and navigate to deeper levels of information as required. - -Weave GitOps is an open source project sponsored by [Weaveworks](https://weave.works) - the GitOps company, and original creators of [Flux](https://fluxcd.io). - -## Why adopt GitOps? - -> "GitOps is the best thing since configuration as code. Git changed how we collaborate, but declarative configuration is the key to dealing with infrastructure at scale, and sets the stage for the next generation of management tools" - -- Kelsey Hightower, Staff Developer Advocate, Google.

- -Adopting GitOps can bring a number of key benefits: - -- Faster and more frequent deployments -- Easy recovery from failures -- Improved security and auditability - -To learn more about GitOps, check out these resources: - -- [GitOps for absolute beginners](https://go.weave.works/WebContent-EB-GitOps-for-Beginners.html) - eBook from Weaveworks -- [Guide to GitOps](https://www.weave.works/technologies/gitops/) - from Weaveworks -- [OpenGitOps](https://opengitops.dev/) - CNCF Sandbox project aiming to define a vendor-neutral, principle-led meaning of GitOps. -- [gitops.tech](https://www.gitops.tech/) - supported by Innoq - -## Getting Started - -To start your own journey with Weave GitOps, please see [Installation](./installation/index.mdx) and [Getting Started](./getting-started.mdx). - -Here is a quick demo of what you can look forward to: - -import ReactPlayer from "react-player/lazy"; - -
- -
- -## Features - -- **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. -- Drill down into more detailed information on any given Flux resource. -- Uncover relationships between resources and quickly navigate between them. -- Understand how workloads are reconciled through a directional graph. -- View Kubernetes events relating to a given object to understand issues and changes. -- Secure access to the dashboard through the ability to integrate with an OIDC provider (such as Dex) or through a configurable cluster user. -- Fully integrates with [Flux](https://fluxcd.io/docs/) as the GitOps engine to provide: - - Continuous Delivery through GitOps for apps and infrastructure - - Support for GitHub, GitLab, Bitbucket, and even use s3-compatible buckets as a source; all major container registries; and all CI workflow providers. - - A secure, pull-based mechanism, operating with least amount of privileges, and adhering to Kubernetes security policies. - - Compatible with any conformant [Kubernetes version](https://fluxcd.io/docs/installation/#prerequisites) and common ecosystem technologies such as Helm, Kustomize, RBAC, Prometheus, OPA, Kyverno, etc. - - Multitenancy, multiple git repositories, multiple clusters - - Alerts and notifications - -## Weave GitOps 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. - -### How to purchase - -Get in touch with sales@weave.works to discuss your needs. diff --git a/website/docs/intro.mdx b/website/docs/intro.mdx new file mode 100644 index 00000000000..4f928265e28 --- /dev/null +++ b/website/docs/intro.mdx @@ -0,0 +1,98 @@ +--- +title: Introduction +hide_title: true +--- + +# Weave GitOps + +Weave GitOps is a powerful extension to [Flux][flux], a leading GitOps engine and +CNCF project. Weave GitOps provides insights into your application deployments, +and makes continuous delivery with GitOps easier to adopt and scale across your teams. + +Its web UI surfaces key information to help application operators easily discover +and resolve issues. The intuitive interface provides a guided experience to build +understanding and simplify getting started for new users; they can easily discover +the relationship between Flux objects and navigate to deeper levels of information as required. + +Weave GitOps is an open source project sponsored by [Weaveworks](https://weave.works) - the GitOps company, +and original creators of [Flux][flux]. + +## Getting Started + +To start your own journey with Weave GitOps, please see [Installation](./installation/index.mdx) and [Getting Started](./getting-started.mdx). + +Here is a quick demo of what you can look forward to: + +import ReactPlayer from "react-player/lazy"; + +
+ +
+ +## Features + +OSS Weave GitOps has a number of awesome features to take your team beyond a simple CI/CD system. + +- :female-construction-worker: Drill down into more detailed information on any given Flux resource. +- :mag: Uncover relationships between resources and quickly navigate between them. +- :thinking_face: Understand how workloads are reconciled through a directional graph. +- :goggles: View Kubernetes events relating to a given object to understand issues and changes. +- :no_pedestrians: Secure access to the dashboard through the ability to integrate with an OIDC provider (such as Dex) or through a configurable cluster user. +- :link: Fully integrates with [Flux](https://fluxcd.io/docs/) as the GitOps engine to provide: + - :infinity: Continuous Delivery through GitOps for apps and infrastructure + - :jigsaw: Support for GitHub, GitLab, Bitbucket, and even use s3-compatible buckets as a source; all major container registries; and all CI workflow providers. + - :key: A secure, pull-based mechanism, operating with least amount of privileges, and adhering to Kubernetes security policies. + - :electric_plug: Compatible with any conformant [Kubernetes version](https://fluxcd.io/docs/installation/#prerequisites) and common ecosystem technologies such as Helm, Kustomize, RBAC, Prometheus, OPA, Kyverno, etc. + - :office: Multitenancy, multiple git repositories, multiple clusters + - :exclamation: Alerts and notifications + +## Weave GitOps Enterprise + +import Link from '@docusaurus/Link'; + +Need even more GitOps? **Weave GitOps Enterprise Edition (WGEE)** has all the features +listed above, plus many more. + +WGEE 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. + +- :boat: **Cluster Fleet Management** +- :closed_lock_with_key: **Trusted Application Delivery** +- :black_right_pointing_double_triangle_with_vertical_bar: **Progressive Delivery** +- :point_up_2: **Self-Service Templates and Profiles** +- :sparkling_heart: **Health Status and Compliance Dashboards** +- :factory_worker::female-factory-worker: **Team Workspaces** +- :compass: **Kubernetes Anywhere** +- :bell: **Critical 24/7 Support** +- :infinity: **CD Pipelines** + +:::tip Want to learn more about how Weave GitOps Enterprise Edition can help your team? +Get in touch with sales@weave.works to discuss your needs. +::: + +## Why adopt GitOps? + +> "GitOps is the best thing since configuration as code. Git changed how we collaborate, but declarative configuration is the key to dealing with infrastructure at scale, and sets the stage for the next generation of management tools" + +- Kelsey Hightower, Staff Developer Advocate, Google.

+ +Adopting GitOps can bring a number of key benefits: + +- Faster and more frequent deployments +- Easy recovery from failures +- Improved security and auditability + +To learn more about GitOps, check out these resources: + +- [GitOps for absolute beginners](https://go.weave.works/WebContent-EB-GitOps-for-Beginners.html) - eBook from Weaveworks +- [Guide to GitOps](https://www.weave.works/technologies/gitops/) - from Weaveworks +- [OpenGitOps](https://opengitops.dev/) - CNCF Sandbox project aiming to define a vendor-neutral, principle-led meaning of GitOps. +- [gitops.tech](https://www.gitops.tech/) - supported by Innoq + +[flux]: https://fluxcd.io diff --git a/website/docs/pipelines/authorization.mdx b/website/docs/pipelines/authorization.mdx index 4e7f35a672a..a32c972664b 100644 --- a/website/docs/pipelines/authorization.mdx +++ b/website/docs/pipelines/authorization.mdx @@ -8,7 +8,7 @@ import TierLabel from "./../_components/TierLabel"; import CodeBlock from "@theme/CodeBlock"; import BrowserOnly from "@docusaurus/BrowserOnly"; -# Authorization +# Authorization This section provides a recommended way to configure RBAC in the context of pipelines. It is oriented to the journey that you expect your users to have. @@ -46,4 +46,4 @@ roleRef: kind: ClusterRole name: pipeline-reader apiGroup: rbac.authorization.k8s.io -``` \ No newline at end of file +``` diff --git a/website/docs/pipelines/getting-started.mdx b/website/docs/pipelines/getting-started.mdx index f6d05bf56c1..55614b15f1f 100644 --- a/website/docs/pipelines/getting-started.mdx +++ b/website/docs/pipelines/getting-started.mdx @@ -8,7 +8,7 @@ import TierLabel from "./../_components/TierLabel"; import CodeBlock from "@theme/CodeBlock"; import BrowserOnly from "@docusaurus/BrowserOnly"; -# Getting started with pipelines +# Getting started with pipelines ## Requirements :::note Feature toggle diff --git a/website/docs/pipelines/pipeline-templates.mdx b/website/docs/pipelines/pipeline-templates.mdx index bd0659b3c99..561063a5cdf 100644 --- a/website/docs/pipelines/pipeline-templates.mdx +++ b/website/docs/pipelines/pipeline-templates.mdx @@ -8,7 +8,7 @@ import TierLabel from "./../_components/TierLabel"; import CodeBlock from "@theme/CodeBlock"; import BrowserOnly from "@docusaurus/BrowserOnly"; -# Using GitOpsTemplates for Pipelines +# Using GitOpsTemplates for Pipelines To create new Pipelines and their required resources from within Weave GitOps Enterprise, you can leverage [GitOpsTemplates](../../gitops-templates/templates) to help platform teams scale for developer self-service. diff --git a/website/docs/pipelines/promoting-applications.mdx b/website/docs/pipelines/promoting-applications.mdx index f3484a69c86..faa72186250 100644 --- a/website/docs/pipelines/promoting-applications.mdx +++ b/website/docs/pipelines/promoting-applications.mdx @@ -8,7 +8,7 @@ import TierLabel from "./../_components/TierLabel"; import CodeBlock from "@theme/CodeBlock"; import BrowserOnly from "@docusaurus/BrowserOnly"; -# Promoting applications through pipeline environments +# Promoting applications through pipeline environments Pipelines allow you to configure automatic promotions of applications through a consecutive set of environments, e.g. from dev to staging to production. The environments are defined in the `Pipeline` resource itself so that each pipeline governs a single application and all the environments to which it is deployed. diff --git a/website/docs/pipelines/spec/v1alpha1/pipeline.mdx b/website/docs/pipelines/spec/v1alpha1/pipeline.mdx index 9efc20e116b..003b68193b3 100644 --- a/website/docs/pipelines/spec/v1alpha1/pipeline.mdx +++ b/website/docs/pipelines/spec/v1alpha1/pipeline.mdx @@ -2,7 +2,9 @@ title: Pipeline hide_title: true --- -# Pipeline +import TierLabel from "../../../_components/TierLabel"; + +# Pipeline The Pipeline API defines a resource for continuous delivery pipelines. diff --git a/website/docs/policy/commit-time-checks.mdx b/website/docs/policy/commit-time-checks.mdx index d5a6cc3cef8..81001add492 100644 --- a/website/docs/policy/commit-time-checks.mdx +++ b/website/docs/policy/commit-time-checks.mdx @@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem"; import TierLabel from "../_components/TierLabel"; -# Commit/Build time checks +# Commit/Build time checks ## Overview Weave GitOps Enterprise enable developers and operators to check policy violations early in their software development life cycle, specifically at commit and build time. Developers and operators can have Weave Policy Validator integrated in their CI tools to validate whether their code changes are violating any policies or not. diff --git a/website/docs/policy/configuration.mdx b/website/docs/policy/configuration.mdx index a844375eb90..0412f181f36 100644 --- a/website/docs/policy/configuration.mdx +++ b/website/docs/policy/configuration.mdx @@ -3,8 +3,9 @@ title: Weave Policy Agent Configuration hide_title: true --- +import TierLabel from "../_components/TierLabel"; -# Configuration +# Configuration The config file is the single entry point for configuring the agent. diff --git a/website/docs/policy/getting-started.mdx b/website/docs/policy/getting-started.mdx index 3ef807d98cf..5aa0d3ee0b1 100644 --- a/website/docs/policy/getting-started.mdx +++ b/website/docs/policy/getting-started.mdx @@ -7,7 +7,7 @@ import TierLabel from "../_components/TierLabel"; import CodeBlock from "@theme/CodeBlock"; import BrowserOnly from "@docusaurus/BrowserOnly"; -# Getting started +# Getting started This section introduces you to the Policy Profile and details the steps required to install it in Weave GitOps. diff --git a/website/docs/policy/policy-configuration.mdx b/website/docs/policy/policy-configuration.mdx index 3f897474857..d0fafdeb793 100644 --- a/website/docs/policy/policy-configuration.mdx +++ b/website/docs/policy/policy-configuration.mdx @@ -3,7 +3,9 @@ title: Weave Policy Configuration hide_title: true --- -# Policy Configuration +import TierLabel from "../_components/TierLabel"; + +# Policy Configuration ## Goal diff --git a/website/docs/policy/policy-set.mdx b/website/docs/policy/policy-set.mdx index 381c85d4769..d0ea41d9a4a 100644 --- a/website/docs/policy/policy-set.mdx +++ b/website/docs/policy/policy-set.mdx @@ -3,8 +3,9 @@ title: Weave Policy Set hide_title: true --- +import TierLabel from "../_components/TierLabel"; -# PolicySet +# PolicySet This is an optional resource. It is used to select group of policies to work in specific modes. diff --git a/website/docs/policy/releases.mdx b/website/docs/policy/releases.mdx index ae6ac8d5a8d..722bbf8c727 100644 --- a/website/docs/policy/releases.mdx +++ b/website/docs/policy/releases.mdx @@ -5,7 +5,7 @@ hide_title: true import TierLabel from "../_components/TierLabel"; -# Profile Releases +# Profile Releases ## v0.6.5 diff --git a/website/docs/policy/weave-policy-profile.mdx b/website/docs/policy/weave-policy-profile.mdx index 621e61b9fd2..0543517eaab 100644 --- a/website/docs/policy/weave-policy-profile.mdx +++ b/website/docs/policy/weave-policy-profile.mdx @@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem"; import TierLabel from "../_components/TierLabel"; -# Weave policy profile +# Weave policy profile # Weave Policy Profile diff --git a/website/docs/releases.mdx b/website/docs/releases.mdx index 5afe0f8fd8b..e8941d11ec9 100644 --- a/website/docs/releases.mdx +++ b/website/docs/releases.mdx @@ -4,9 +4,9 @@ hide_title: true --- import TierLabel from "./_components/TierLabel"; -# Releases +# Releases -:::note +:::info This page details the changes for Weave GitOps Enterprise and its associated components. For Weave GitOps OSS - please see the release notes on [GitHub](https://github.com/weaveworks/weave-gitops/releases). ::: ## v0.15.1 diff --git a/website/sidebars.js b/website/sidebars.js index 9c7caf984af..b719f0da0c6 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -36,6 +36,17 @@ module.exports = { ], }, 'getting-started', + { + type: 'category', + label: 'Enterprise Edition', + link: { + type: 'doc', + id: 'intro-ee', + }, + items: [ + 'releases', + ], + }, { type: 'category', label: 'Configuration', @@ -71,8 +82,11 @@ module.exports = { { type: 'category', label: 'Cluster Management', + link: { + type: 'doc', + id: 'cluster-management/intro', + }, items: [ - 'cluster-management/intro', 'cluster-management/getting-started', 'cluster-management/cluster-api-providers', 'cluster-management/managing-existing-clusters', @@ -116,13 +130,15 @@ module.exports = { { type: 'category', label: 'Pipelines', + link: { + type: 'doc', + id: 'pipelines/intro', + }, items: [ - 'pipelines/intro', 'pipelines/getting-started', 'pipelines/authorization', 'pipelines/promoting-applications', 'pipelines/pipeline-templates', - 'pipelines/pipeline-templates', { type: 'category', label: 'Reference', @@ -141,8 +157,11 @@ module.exports = { { type: 'category', label: 'Workspaces', + link: { + type: 'doc', + id: 'workspaces/intro', + }, items: [ - 'workspaces/intro', 'workspaces/multi-tenancy', 'workspaces/view-workspaces', ], @@ -173,7 +192,6 @@ module.exports = { }, 'help-and-support', 'feedback-and-telemetry', - 'releases', { type: 'category', label: 'References',