Skip to content

Commit a71a4c0

Browse files
committed
last refactoring before opening pr
Signed-off-by: Eneko Fernandez <[email protected]>
1 parent 2daceb0 commit a71a4c0

7 files changed

+45
-90
lines changed

website/docs/enterprise/getting-started/install-enterprise-getting-started-advanced-topics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Advanced Topics
33
hide_title: true
44
toc_max_heading_level: 4
5-
pagination_prev: enterprise/getting-started/install-enterprise-getting-started-onboard
5+
pagination_prev: enterprise/getting-started/install-enterprise-getting-started-harden
66
pagination_next: enterprise/getting-started/install-enterprise-getting-started-expand
77

88
---

website/docs/enterprise/getting-started/install-enterprise-getting-started-expand.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Step 3 - Expand Capabilities
33
hide_title: true
44
toc_max_heading_level: 4
5-
pagination_prev: enterprise/getting-started/install-enterprise-getting-started-onboard
5+
pagination_prev: enterprise/getting-started/install-enterprise-getting-started-harden
66
---
77

88
import Tabs from "@theme/Tabs";

website/docs/enterprise/getting-started/install-enterprise-getting-started-onboard.mdx renamed to website/docs/enterprise/getting-started/install-enterprise-getting-started-harden.mdx

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Step 2 - Complete and Onboard
2+
title: Step 2 - Harden
33
hide_title: true
4-
toc_max_heading_level: 4
5-
pagination_prev: enterprise/getting-started/install-enterprise-getting-started-onboard
4+
toc_max_heading_level: 3
5+
pagination_prev: enterprise/getting-started/install-enterprise-getting-started-harden
66
pagination_next: enterprise/getting-started/install-enterprise-getting-started-expand
77
---
88

@@ -15,7 +15,7 @@ import oauthBitbucket from '/img/oauth-bitbucket.png';
1515
import oauthAzureDevOps from '/img/oauth-azure-devops.png';
1616
import oauthAzureDevOpsSuccess from '/img/oauth-azure-devops-success.png';
1717

18-
# Step 2 - Complete and Onboard
18+
# Step 2 - Harden
1919

2020
:::info What to expect
2121
You have [started with WGE](../install-enterprise-getting-started) and already familiar with its [bootstrapping workflow](../install-enterprise-getting-started/#bootstrapping).
@@ -24,13 +24,11 @@ You now want to complete your baseline setup before onboarding the rest of the t
2424
This guide provides you with recommendations to meet this bar. At the end of it, you are ready to onboard the rest of the team.
2525
:::
2626

27-
## Authentication
27+
## Setup OIDC Authentication
2828

2929
As a reminder, Weave GitOps Enterprise supports as authentication methods, `Cluster User`, that you have likely setup as part of the previous step, and `OIDC`.
3030
OIDC is the recommended way for production, so take the time to set it up before onboarding other users.
3131

32-
### OIDC
33-
3432
:::warning
3533
Currently, we do not have a persistent session storage, this means that if you scale to multiple replicas, logins will not be persisted.
3634
:::
@@ -122,7 +120,7 @@ Use [`gitops check oidc-config`](../../../references/cli-reference/gitops_check_
122120
See [Advanced Topics](#advanced-topics) for other OIDC topics like customise scopes.
123121
:::
124122

125-
## Authorization
123+
## Configure OIDC Authorization
126124

127125
Weave GitOps Enterprise works with standard [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) to authorise:
128126

@@ -133,11 +131,9 @@ Weave GitOps Enterprise works with standard [Kubernetes RBAC](https://kubernetes
133131
During [getting started](../install-enterprise-getting-started/) you have created the default RBAC for the `Cluser User`, `Weave GitOps Service Account`
134132
and `Flux Service Accounts` but not for OIDC users.
135133

136-
### OIDC
137-
138134
Setup Authorization for OIDC users by both defining and deploying the RBAC rules.
139135

140-
#### Defining RBAC Rules
136+
### Defining RBAC Rules
141137

142138
RBAC rules are highly context-dependent and there is no one-size fits all. You would need to take the time with your Security organisation on defining them.
143139
We provide you with the following RBAC Configuration as inspirational to get you conversations started: It is purposefully vague as we intend to give a
@@ -290,7 +286,7 @@ cluster client (and vice versa).
290286

291287
</details>
292288

293-
#### Deploy them via `/bases`
289+
### Deploy them via `/bases`
294290

295291
Once you have the rules defined, you want to ensure they are available in your environment. The `bases` pattern is a useful approach
296292
to easily achieve this. It works as follows:
@@ -332,9 +328,7 @@ resources will be created.
332328
</TabItem>
333329
</Tabs>
334330

335-
## Configure Weave GitOps Enterprise
336-
337-
### Enable Write Access to Git
331+
## Enable Write Access to Git
338332

339333
Weave GitOps Enterprise creates pull requests for adding resources. To do this, it needs to be able to write to the Git repository.
340334
Here we provide guidance for GitHub, GitLab, BitBucket Server, and Azure DevOps.
@@ -457,14 +451,10 @@ Note that each user can view and manage which applications they have authorized
457451
</TabItem>
458452
</Tabs>
459453

460-
## Access the dashboard
454+
## Configure Service and Ingress
461455

462456
During [getting started](../install-enterprise-getting-started/) you have accessed the dashboard via its non-TLS ClusterIP service
463-
which is not recommended to use for production environments. Use this section to evolve your access before onboarding users.
464-
465-
### Configure Service and Ingress
466-
467-
Weave GitOps Enterprise dashboard is by default available via its ClusterIP service. You could To achieve other networking configurations
457+
which is not recommended to use for production environments. You could To achieve other networking configurations
468458
by modifying the `service` or `ingress` in the `HelmRelease` values:
469459

470460
```yaml
@@ -482,7 +472,7 @@ spec:
482472
...
483473
```
484474

485-
### Configure TLS
475+
## Configure TLS
486476

487477
By default, the WGE UI pod will listen on port `8000` with TLS enabled.
488478
WGE will generate and use a self-signed certificate for this purpose.
@@ -508,7 +498,6 @@ Other ingress conguration changes can be made via the ingress configuration
508498
... other parameters specific to the ingress type ...
509499
```
510500

511-
512501
## Next Steps
513502

514503
Onboard the rest of the Platform Engineering team and head to [Step 3 - Expand](../install-enterprise-getting-started-expand) to extend

website/docs/enterprise/getting-started/install-enterprise-getting-started-manual.mdx

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,20 @@
22
title: Manually
33
hide_title: false
44
pagination_prev: enterprise/getting-started/install-enterprise-getting-started
5-
pagination_next: enterprise/getting-started/install-enterprise-getting-started-onboard
5+
pagination_next: enterprise/getting-started/install-enterprise-getting-started-harden
66
toc_max_heading_level: 4
77
---
88

99
import Tabs from "@theme/Tabs";
1010
import TabItem from "@theme/TabItem";
11-
import TierLabel from "@site/docs/_components/TierLabel";
12-
import AlphaWarning from "../../_components/_alpha_warning.mdx";
1311
import CurlCodeBlock from "../../_components/CurlCodeBlock";
14-
import oauthBitbucket from '/img/oauth-bitbucket.png';
15-
import oauthAzureDevOps from '/img/oauth-azure-devops.png';
16-
import oauthAzureDevOpsSuccess from '/img/oauth-azure-devops-success.png';
1712

1813
# Getting Started Manually
1914

20-
This guide will walk you through to manual getting started [bootstrapping](../install-enterprise-getting-started/#bootstrapping) route for Weave GitOps Enterprise.
21-
22-
:::caution This guide aims to easy discovery or day-0 experiences.
15+
:::info What to expect
16+
You are a Platform Engineer in charge of discovering or setting up Weave GitOps Enterprise for your organisation.
2317

24-
Ensure you complete the [rest of the journeys](../install-enterprise-getting-started/) if you aim to onboard other Platform Engineers or Developers.
18+
This guide will walk you through to manual getting started [bootstrapping](../install-enterprise-getting-started/#bootstrapping) route for Weave GitOps Enterprise.
2519
:::
2620

2721
## Bootstrap Flux
@@ -37,15 +31,7 @@ flux bootstrap git --url="https://example.com/repository.git" --"password=passwo
3731
flux bootstrap git --url="ssh://[email protected]/repository.git" --private-key-file="path/to/private.key" --password="password" --path="clusters/my-cluster"
3832
```
3933

40-
## Entitlements
41-
42-
Weave GitOps Enterprise Entitlement is your obtained license to use our product. The Entitlements file is a Kubernetes secret that contains your licence.
43-
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.
44-
45-
```bash
46-
kubectl apply -n flux-system -f entitlements.yaml
47-
```
48-
## Authentication
34+
## Configure Authentication
4935

5036
There are two supported authentication methods for Weave GitOps Enterprise:
5137

@@ -92,7 +78,7 @@ Use these credentials to login as `ClusterUser` via the UI.
9278
Ensure your [authentication is fit for production](../install-enterprise-onboard-platform-engineers#authentication) before onboarding other Platform Engineers or Developers.
9379
:::
9480

95-
## Authorization
81+
## Configure Authorization
9682

9783
Weave GitOps Enterprise works with standard [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/)
9884
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
175161
Ensure your [authorization is fit for production](../install-enterprise-onboard-platform-engineers#authorization) before onboarding other Platform Engineers or Developers.
176162
:::
177163

178-
## Install WGE
164+
## Deploy the HelmRelease
179165

180166
We install Weave GitOps Enterprise via Flux Helm Release that you could deploy via the CLI or manually:
181167

website/docs/enterprise/getting-started/install-enterprise-getting-started.mdx

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Step 1 - Getting Started
33
hide_title: true
4-
pagination_prev: enterprise/getting-started/intro-enterprise
5-
pagination_next: enterprise/getting-started/install-enterprise-getting-started-onboard
4+
pagination_prev: enterprise/getting-started/intro
5+
pagination_next: enterprise/getting-started/install-enterprise-getting-started-harden
66
toc_max_heading_level: 4
77
---
88

@@ -72,20 +72,10 @@ To get the entitlement secret please contact *[email protected]*, then apply it
7272
```
7373
## Bootstrapping
7474

75-
Bootstrapping is the workflow that installs Weave GitOps Enterprise in your environment by executing these stages:
75+
Bootstrap Weave GitOps Enterprise in your environment by any of these methods:
7676

77-
1. **Bootstrap Flux**: bootstrap Flux on your Management Cluster.
78-
2. **Entitlements**: verify your Entitlements.
79-
3. **Authentication**: configure how users authenticate.
80-
4. **Authorization**: configure what your users and other subjects can do.
81-
5. **Install WGE**: deploy Weave GitOps Enterprise via Flux Helm Release.
82-
6. **Access the dashboard**: access the application as you expect.
83-
7. **Extend WGE**: add other capabilities to support your Platform workflows.
84-
85-
Run the method that better match your expectations.
86-
87-
<Tabs groupId="flux bootstrap" defaultValue="cli-interactive">
88-
<TabItem value="cli-interactive" label="CLI Interactive">
77+
<Tabs groupId="bootstrap" defaultValue="cliInteractive">
78+
<TabItem value="cliInteractive" label="CLI Interactive">
8979

9080
:::tip Recommended path if:
9181

@@ -101,7 +91,7 @@ You have limited knowledge about the product and / or want guidance step-by-step
10191

10292
<AlphaWarning/>
10393
</TabItem>
104-
<TabItem value="cli-not-interactive" label="CLI Non Interactive">
94+
<TabItem value="cliNotInteractive" label="CLI Non Interactive">
10595

10696
:::tip Recommended Path if:
10797
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 \
135125
You want to have full control on the process or your context cannot be handled via the CLI.
136126
:::
137127

138-
Continue to [Manual Bootstrapping](../install-enterprise-getting-started-manual) to guide you.
128+
Execute the following tasks to manually bootstrap:
129+
130+
1. [**Bootstrap Flux**](../install-enterprise-getting-started-manual/#bootstrap-flux)
131+
2. [**Configure Authentication**](../install-enterprise-getting-started-manual/#configure-authentication)
132+
3. [**Configure Authorization**](../install-enterprise-getting-started-manual/#configure-authorization)
133+
4. [**Deploy WGE HelmRelease**](../install-enterprise-getting-started-manual/#deploy-the-helmrelease)
139134

140135
</TabItem>
141136
</Tabs>
@@ -159,5 +154,5 @@ Access your browser on [http://localhost:8000](http://localhost:8000) to see the
159154
## Next Steps
160155

161156
You have bootstrapped Weave GitOps Enterprise and Flux on your Management Cluster. Continue to
162-
[Step 2 - Onboarding](../install-enterprise-getting-started-onboard) to harden your environment
157+
[Step 2 - Onboarding](../install-enterprise-getting-started-harden) to harden your environment
163158
to onboard the rest of the team.

website/docs/enterprise/getting-started/intro-enterprise.mdx renamed to website/docs/enterprise/getting-started/intro.mdx

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,18 @@ import Link from "@docusaurus/Link";
77

88
# Weave GitOps Enterprise <TierLabel tiers="Enterprise" />
99

10-
:::tip Ready for more GitOps?
11-
To purchase an entitlement to Weave GitOps Enterprise, please contact [[email protected]](mailto:[email protected]).
12-
:::
13-
1410
[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.
1511

16-
- Continue to [Getting Started](#getting-started) to start your Weave GitOpps Enterprise journey.
17-
- Reade more about [features](#feature-breakdown) or in [Weave GitOps Enterprise FAQ](https://www.weave.works/product/enterprise-faq/) for more information.
18-
19-
## Install
20-
21-
You are a Platform Engineer who is in charge of discovering or setting up Weave GitOps Enterprise (WGE) for your organisation.
22-
We propose you to tackle it in three days:
23-
24-
### Step 1: Getting Started
12+
:::tip Start onboarding
2513

26-
[**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.
14+
As a Platform Engineer, you bear the task of either exploring or establishing Weave GitOps Enterprise (WGE)
15+
within your organization. We suggest that you onboard following these steps:
2716

28-
### Step 2: Onboard the team
29-
30-
[**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.
31-
32-
[**Onboard Developers**](../install-enterprise-onboard): the platform capabilities have been setup and you ready to start onboard developers.
33-
34-
### Day 2: Operate & Improve
35-
36-
- TBA
17+
- [**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.
18+
- [**Step 2 - Harden**](../install-enterprise-getting-started-harden) your setup and onboard to other Platform Engineers.
19+
- [**Step 3 - Expand**](../install-enterprise-expand) what WGE can do with the rest of the Platform Engineering team.
20+
- [**Step 4 - Onboard and Operate**](../install-enterprise-expand): onboard your Developers and operate the Platform.
21+
:::
3722

3823
## Feature Breakdown
3924

website/sidebars.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ module.exports = {
3636
label: "Weave GitOps Enterprise",
3737
link: {
3838
type: "doc",
39-
id: "enterprise/getting-started/intro-enterprise",
39+
id: "enterprise/getting-started/intro",
4040
},
4141
items: [
4242
{
@@ -52,10 +52,10 @@ module.exports = {
5252
},
5353
{
5454
type: "category",
55-
label: "Step 2 - Complete and Onboard",
55+
label: "Step 2 - Harden",
5656
link: {
5757
type: "doc",
58-
id: "enterprise/getting-started/install-enterprise-getting-started-onboard",
58+
id: "enterprise/getting-started/install-enterprise-getting-started-harden",
5959
},
6060
items: [
6161
"enterprise/getting-started/install-enterprise-getting-started-advanced-topics",

0 commit comments

Comments
 (0)