Skip to content

Commit

Permalink
chore(deps): upgrade docusaurus to v3 (#4280)
Browse files Browse the repository at this point in the history
* chore(deps): upgrade docusaurus to v3

* docs: fix import statements

* docs: fix code blocks

* docs: fix raw links

* docs: fix details/summary

* docs: fix lt and gt

* docs: fix h3 and td

* docs: fix missing imports

* docs: escape { }

* docs: fix toc

* docs: fix broken links

* docs: fix broken anchors
  • Loading branch information
tenstad authored Dec 26, 2024
1 parent ab3efb4 commit 0c0a887
Show file tree
Hide file tree
Showing 962 changed files with 10,439 additions and 5,924 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
uses: actions/configure-pages@v5
- uses: actions/setup-node@v4
with:
node-version: '16.x'
node-version: '18.x'
- name: Build docs
env:
NODE_OPTIONS: "--max-old-space-size=4096"
Expand Down
6 changes: 4 additions & 2 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ Smaller chunks are usually fine. But for anything more that 10 lines it is
neater to wrap it.
~~~markdown
<details><summary>Expand to see this awesome HelmRepository</summary>
<details>
<summary>Expand to see this awesome HelmRepository</summary>
Don't forget to leave a line break below the opening tag...
```yaml
Expand All @@ -141,7 +142,8 @@ and before the closing one.
</details>
~~~
<details><summary>Expand to see this awesome HelmRepository</summary>
<details>
<summary>Expand to see this awesome HelmRepository</summary>
Don't forget to leave a line break below the opening tag...
```
Expand Down
6 changes: 4 additions & 2 deletions website/docs/cluster-management/deploying-capa-eks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ import WegoAdmin from "!!raw-loader!./assets/rbac/wego-admin.yaml";
)}
</BrowserOnly>

<details><summary>Expand to see full template yaml</summary>
<details>
<summary>Expand to see full template yaml</summary>

<CodeBlock
title="clusters/bases/rbac/wego-admin.yaml"
Expand Down Expand Up @@ -127,7 +128,8 @@ Download the config with:

Then update the `GITOPS_REPO` variable to point to your cluster

<details><summary>Expand to see full yaml</summary>
<details>
<summary>Expand to see full yaml</summary>

<CodeBlock
title="clusters/management/capi/boostrap/capi-gitops-cluster-bootstrap-config.yaml"
Expand Down
18 changes: 12 additions & 6 deletions website/docs/cluster-management/managing-clusters-without-capi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ import BrowserOnly from "@docusaurus/BrowserOnly";
You do **not** need Cluster API to add your Kubernetes cluster to Weave GitOps Enterprise. The only thing you need is a secret containing a valid `kubeconfig`.

import TOCInline from "@theme/TOCInline";
<TOCInline />

<TOCInline toc={toc} />

<Tabs groupId="have-a-secret" default>
<TabItem value="existing-kubeconfig-secret" label="Existing kubeconfig">
Expand Down Expand Up @@ -48,7 +49,8 @@ Here's how to create a kubeconfig secret.

2. Add RBAC permissions for the service account:

<details><summary>Expand to see role manifests</summary>
<details>
<summary>Expand to see role manifests</summary>

```yaml
---
Expand Down Expand Up @@ -103,7 +105,8 @@ Here's how to create a kubeconfig secret.

4. Create a kubeconfig secret. We'll use a helper script to generate the kubeconfig, and then save it into `static-kubeconfig.sh`:

<details><summary>Expand to see script</summary>
<details>
<summary>Expand to see script</summary>

```bash title="static-kubeconfig.sh"
#!/bin/bash
Expand Down Expand Up @@ -215,7 +218,8 @@ Download the config with:
Then update the `GITHUB_USER` variable to point to your repository
<details><summary>Expand to see full yaml</summary>
<details>
<summary>Expand to see full yaml</summary>
<CodeBlock
title="clusters/management/capi/boostrap/capi-gitops-cluster-bootstrap-config.yaml"
Expand Down Expand Up @@ -244,7 +248,8 @@ import WegoAdmin from "!!raw-loader!./assets/rbac/wego-admin.yaml";
)}
</BrowserOnly>
<details><summary>Expand to see full template yaml</summary>
<details>
<summary>Expand to see full template yaml</summary>
<CodeBlock
title="clusters/bases/rbac/wego-admin.yaml"
Expand Down Expand Up @@ -299,7 +304,8 @@ Once Flux has reconciled the cluster, you can inspect your Flux resources via th
To test that your kubeconfig secret is correctly set up, apply the following manifest and check the logs after the job completes:
<details><summary>Expand to see manifest</summary>
<details>
<summary>Expand to see manifest</summary>
```yaml
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ We are going to install [ChartMuseum](https://chartmuseum.com/) via Flux.
Remember to also install helm plugin
[cm-push](https://github.com/chartmuseum/helm-push).

<details><summary>Expand to see installation yaml</summary>
<details>
<summary>Expand to see installation yaml</summary>

```yaml
---
Expand Down Expand Up @@ -190,7 +191,8 @@ EOF
```
Execute `make` using the following makefile to intialise CAPI in your cluster:

<details><summary>Expand to see Makefile contents</summary>
<details>
<summary>Expand to see Makefile contents</summary>

```makefile
.PHONY := capi
Expand Down Expand Up @@ -237,7 +239,8 @@ capi-cluster:

Apply the following example manifest to deploy the Terraform Controller:

<details><summary>Expand to see file contents</summary>
<details>
<summary>Expand to see file contents</summary>

```yaml
apiVersion: source.toolkit.fluxcd.io/v1beta2
Expand Down Expand Up @@ -278,7 +281,8 @@ spec:

Update the following manifest to your context.

<details><summary>Expand to see file contents</summary>
<details>
<summary>Expand to see file contents</summary>

```yaml {4-7,19-20}
---
Expand Down Expand Up @@ -422,7 +426,8 @@ ghcr.io/fluxcd/notification-controller:v0.25.2
This section guides you to push installed artifacts to your private registry.
Here's a Makefile to help you with each stage:

<details><summary>Expand to see Makefile contents</summary>
<details>
<summary>Expand to see Makefile contents</summary>

```makefile {4-6}
.PHONY := all
Expand Down Expand Up @@ -493,7 +498,8 @@ Follow the instructions to install WGE with the following considerations:

An example of how it would look for Weave GitOps Enterprise is shown below.

<details><summary>Expand to view example WGE manifest</summary>
<details>
<summary>Expand to view example WGE manifest</summary>

```yaml title="weave-gitops-enterprise.yaml" {21-24,32}
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Azure and Weave GitOps Enterprise Installation
hide_title: true
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import TierLabel from "@site/docs/_components/TierLabel";
import oauthBitbucket from '/img/oauth-bitbucket.png';
import oauthAzureDevOps from '/img/oauth-azure-devops.png';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,15 @@ Please use the following command to start the installation wizard of Weave GitOp

`gitops-ee bootstrap` is a workflow that will take you through the following stages:

1. [Verify Flux](#verifying-flux): verify Flux installation on the Management cluster.
1. [Verify Flux](#verify-flux): verify Flux installation on the Management cluster.
2. (Optional) [Bootstrap Flux](#bootstrap-flux): bootstrap Flux in case is not found.
3. [Verify Entitlement](#verifying-entitlement): verify the Entitlements secret content (username, password, entitlement).
3. [Verify Entitlement](#verify-entitlement): verify the Entitlements secret content (username, password, entitlement).
4. [Configure Git Access](#configure-git-access): configure the access to your configuration repo.
5. [Select WGE version](#selecting-wge-version): from the latest 3 available releases.
5. [Select WGE version](#select-wge-version): from the latest 3 available releases.
6. [Create Cluster User](#create-cluster-user): create a Secret with the username and password for the emergency cluster user.
7. [Configure Dashboard Access](#configure-dashboard-access): choose between 2 methods to access the dashboard either local or external.
8. (Optional) [Configure OIDC](#configure-oidc): to enable login to dashboard via OIDC providers.
9. (Optional) [Extra Components](#extra-components): to install extra components from (Policy Agent, Terraform Controller).
8. (Optional) [Configure OIDC](#optional-configure-oidc): to enable login to dashboard via OIDC providers.
9. (Optional) [Extra Components](#optional-extra-components): to install extra components from (Policy Agent, Terraform Controller).
10. [Access the dashboard](#access-the-dashboard): via the link from the installation success message.

#### Verify Flux
Expand Down
15 changes: 10 additions & 5 deletions website/docs/enterprise/getting-started/install-enterprise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,8 @@ kubectl create secret generic github-client \

Use `HelmRepository` and `HelmRelease` objects to let Flux deploy everything.

<details><summary>Expand to see resource manifests</summary>
<details>
<summary>Expand to see resource manifests</summary>

```yaml
---
Expand Down Expand Up @@ -368,7 +369,8 @@ the user.

Based on these groups, we can bind roles to groups:

<details><summary>Expand to see group role bindings</summary>
<details>
<summary>Expand to see group role bindings</summary>

```yaml
---
Expand Down Expand Up @@ -416,7 +418,8 @@ rules:

In the same way, we can bind cluster roles to a group:

<details><summary>Expand to see group cluster role bindings</summary>
<details>
<summary>Expand to see group cluster role bindings</summary>

```yaml
---
Expand Down Expand Up @@ -792,7 +795,8 @@ cluster client (and vice versa).

The yaml to configure these permissions would look roughly like:

<details><summary>Expand to see example RBAC</summary>
<details>
<summary>Expand to see example RBAC</summary>

```yaml
# Admin cluster role
Expand Down Expand Up @@ -1057,7 +1061,8 @@ Download the helm-release to `clusters/management/weave-gitops-enterprise.yaml`.
import ExampleWGE from "../../assets/example-enterprise-helm.yaml";
import ExampleWGEContent from "!!raw-loader!../../assets/example-enterprise-helm.yaml";

<details><summary>Expand to see file contents</summary>
<details>
<summary>Expand to see file contents</summary>

<CurlCodeBlock
localPath="clusters/management/weave-gitops-enterprise.yaml"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ If you already have Flux running, you can create the service account in your fle

1. Create a service account file:

<details><summary>Expand to see role manifests</summary>
<details>
<summary>Expand to see role manifests</summary>

```yaml
apiVersion: v1
Expand All @@ -77,7 +78,8 @@ metadata:
2. Create a roles file:
<details><summary>Expand to see role manifests</summary>
<details>
<summary>Expand to see role manifests</summary>
```yaml
apiVersion: rbac.authorization.k8s.io/v1
Expand Down Expand Up @@ -124,7 +126,8 @@ Kubernetes 1.24+ [will not create secrets for Service Accounts for you](https://
6. Create a kubeconfig secret. We'll use a helper script to generate the kubeconfig, and then save it into `static-kubeconfig.sh`:

<details><summary>Expand to see script</summary>
<details>
<summary>Expand to see script</summary>

```bash title="static-kubeconfig.sh"
#!/bin/bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ _Bug fixes_
- Explorer supports now Flux sources.
- Applications UI and Sources UI could be configured to use Explorer backend to improve UI experience.
- Explorer collector uses impersonation. Ensure you [configure collector](../../explorer/configuration.mdx/#authentication-and-authorization-for-collecting) for your leaf clusters.
- Explorer collector uses impersonation. Ensure you [configure collector](../../../explorer/configuration#authentication-and-authorization-for-collecting) for your leaf clusters.
#### GitopsSets
Expand Down
18 changes: 11 additions & 7 deletions website/docs/explorer/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The following configuration options are available for you to setup Explorer.
- `.spec.values.useQueryServiceBackend`: feature flag to control whether you want to leverage Explorer backend capabilities for
other UI experiences like [Applications](../open-source/getting-started/ui-OSS.mdx#the-applications-view) or [Sources](../open-source/getting-started/ui-OSS.mdx#the-sources-view)
- `.spec.values.explorer.collector.serviceAccount`: ServiceAccount `name` and `namespace` that explorer collector will use to impersonate
in leaf clusters. Make sure you read [authz for collector](#Authentication_and_Authorization_for_collecting) before setting it. Default
in leaf clusters. Make sure you read [authz for collector](#authentication-and-authorization-for-collecting) before setting it. Default
values are `name: collector`, `namespace: flux-system`.

You should specify them in your HelmRelease values:
Expand Down Expand Up @@ -52,7 +52,7 @@ spec:
### Clusters
Explorer watches the [GitopsClusters](../cluster-management/managing-clusters-without-capi.mdx/#connect-a-cluster)
Explorer watches the [GitopsClusters](../../cluster-management/managing-clusters-without-capi#connect-a-cluster)
that you have connected to Weave Gitops Enterprise, as well as your Management cluster.
### Kinds
Expand Down Expand Up @@ -98,7 +98,7 @@ Query results are filtered honouring the access determined via RBAC.
## Authentication and Authorization for collecting
[GitopsClusters](../cluster-management/managing-clusters-without-capi.mdx/#connect-a-cluster)
[GitopsClusters](../../cluster-management/managing-clusters-without-capi#connect-a-cluster)
define the connection and security context that Explorer leverages to collect data from leaf clusters. Given that you have followed the indications
in [setup RBAC](../enterprise/getting-started/install-enterprise.mdx#gitops-dashboard-service-account-permissions), the GitopsCluster service account is able to impersonate any user or group.
Expand All @@ -114,7 +114,8 @@ To configure collection, you would need to extend this configuration with the fo

1. Create a ServiceAccount for the one that you specified in your [setup](#setup) `.spec.values.explorer.collector.serviceAccount`.

<details><summary>Expand to see an example</summary>
<details>
<summary>Expand to see an example</summary>

```yaml
apiVersion: v1
Expand All @@ -129,7 +130,8 @@ metadata:

2. Create a ClusterRole with the permissions to watch the supported resources.

<details><summary>Expand to see an example</summary>
<details>
<summary>Expand to see an example</summary>

```yaml
apiVersion: rbac.authorization.k8s.io/v1
Expand Down Expand Up @@ -158,7 +160,8 @@ rules:

3. Create a ClusterRolebinding to assign previous ClusterRole to the created collector `ServiceAccount`.

<details><summary>Expand to see an example</summary>
<details>
<summary>Expand to see an example</summary>

```yaml
apiVersion: rbac.authorization.k8s.io/v1
Expand All @@ -181,7 +184,8 @@ If you want the collector to watch a particular namespace use a RoleBinding inst

4. Extend impersonation rules to allow service account impersonation for ServiceAccount `collector`

<details><summary>Expand to see an example</summary>
<details>
<summary>Expand to see an example</summary>

```yaml
apiVersion: rbac.authorization.k8s.io/v1
Expand Down
2 changes: 1 addition & 1 deletion website/docs/gitops-templates/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ value of these two annotations:

## Installation

See the Weave Gitops Enterprise [installation instructions](../enterprise/getting-started/install-enterprise.mdx#7-install-the-cli) for details on how to install the EE `gitops` CLI tool.
See the Weave Gitops Enterprise [installation instructions](../../enterprise/getting-started/install-enterprise#install-the-weave-gitops-enterprise-cli-tool) for details on how to install the EE `gitops` CLI tool.

## Getting started

Expand Down
3 changes: 2 additions & 1 deletion website/docs/gitops-templates/profiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ Keys available in the `spec.charts.items` entries and the template variables ava
| `required` | (default=false) Allow the user to de-select this profile |
| `editable` | (default=false) Allow the user to edit the values.yaml of this profile |

<details><summary>Expand for a complete yaml example</summary>
<details>
<summary>Expand for a complete yaml example</summary>

```yaml
spec:
Expand Down
3 changes: 2 additions & 1 deletion website/docs/gitops-templates/quickstart-templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ github repo.
To get started, add the following `HelmRelease` object to your Weave GitOps Enterprise
configuration repo for your management cluster.

<details><summary>Expand to view</summary>
<details>
<summary>Expand to view</summary>

```yaml
---
Expand Down
3 changes: 2 additions & 1 deletion website/docs/gitops-templates/repo-rendered-paths.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ The path for rendered resources is configured via the
- The path can be templated using params
:::

<details><summary>Expand to see example</summary>
<details>
<summary>Expand to see example</summary>

```yaml
spec:
Expand Down
Loading

0 comments on commit 0c0a887

Please sign in to comment.