Skip to content

Commit

Permalink
added documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Eneko Fernandez <eneko@weave.works>
  • Loading branch information
enekofb committed Dec 20, 2023
1 parent 913c130 commit 880b207
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 5 deletions.
3 changes: 1 addition & 2 deletions charts/gitops-server/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ envVars:
value: "true"
- name: WEAVE_GITOPS_FEATURE_CLUSTER
value: "false"
# configures the behaviour for weave gitops runtime ui. if enabled, flux runtime UI
# will show other weave-gitops components like policy-agent
# -- Enable feature this feature flag if you want to expand Flux Runtime UI with other Weave GitOps components like Policy Agent or TF-Controller.
- name: WEAVE_GITOPS_FEATURE_GITOPS_RUNTIME
value: "false"

Expand Down
29 changes: 26 additions & 3 deletions website/docs/open-source/getting-started/ui-OSS.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,31 @@ If you make a mistake configuring one of the resources, you can use WeGO to easi

## The Flux Runtime View

Let's go back to the left-hand menu of the UI and click on `Flux Runtime`. This view provides information on the GitOps engine, which continuously reconciles your desired and live state, and helps users to know which apiVersion to use in manifests. It comes with two tabs: one for controllers, and other for custom resource definitions (CRDs).
Let's go back to the left-hand menu of the UI and click on `Flux Runtime`. This view provides information on the GitOps engine,
which continuously reconciles your desired and live state, and helps users to know which apiVersion to use in manifests.

#### Controllers
:::tip Beyond Flux Runtime

Enable the feature flag [`WEAVE_GITOPS_FEATURE_GITOPS_RUNTIME`](../../references/helm-reference.md) if you want to expand Flux Runtime UI with the ability to
view other Weave GitOps Runtime Components like Policy Agent or TF-Controller

![Runtime view showing Terraform CRDs](/img/dashboard-flux-runtime-terraform-crds.png)

:::

It comes with three tabs:

1. [Flux Versions](#flux-versions) that summaries the versions of flux running in your cluster.
2. [Controllers](#controllers): that shows your installed [GitOps Toolkit Controllers](https://fluxcd.io/flux/components/) and their version.
3. [CRDs](#crds): that shows your installed [GitOps Toolkit Custom Resources Definitions Toolkit Controllers](https://fluxcd.io/flux/components/) and their version.

### Flux Versions

The Flux Versions tab shows your installed [Flux Versions](https://github.com/fluxcd/flux2/releases).

![Flux Runtime view showing the various GitOps Toolkit controllers](/img/dashboard-flux-runtime-versions.png)

### Controllers

The Controllers tab shows your installed [GitOps Toolkit Controllers](https://fluxcd.io/flux/components/) and their version.

Expand All @@ -165,12 +187,13 @@ By default, `flux bootstrap` will install the following controllers:

From this view you can see whether the controllers are healthy and which version of a given component is currently deployed.

#### CRDs
### CRDs

The CRD tab lists the custom resources that the GitOps Toolkit Controllers use. This allows you to see which resources you will be able to create.

![Flux Runtime view showing the various GitOps Toolkit controllers](/img/dashboard-flux-runtime-crd.png)


## Moving On

Now that we are familiar with the dashboard, let's [deploy a new application](./deploy-OSS.mdx) :sparkles:.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 880b207

Please sign in to comment.