Skip to content

Commit be1c5e1

Browse files
authored
fix(docs): add more details to the documentation
Signed-off-by: Chris Butler <[email protected]>
1 parent fd1d12d commit be1c5e1

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ Future work includes:
2626
- Only known to work today with everything on one cluster. The work to expand this is in flight.
2727
- If not using ARO you must either provide your own CA signed certs, or use let's encrypt.
2828
- Must be on 4.16.14 or later.
29-
**- Users must provide a NAT Gateway attached to the worker node subnet when using Azure.**
29+
30+
> [!IMPORTANT]
31+
> Users must provide a NAT Gateway attached to the worker node subnet when using Azure.
3032
3133
## Major versions
3234

@@ -39,8 +41,10 @@ This limits support to OpenShift 4.16 and higher.
3941

4042
The pattern has been tested on Azure for two installation methods:
4143
1. Installing onto an ARO cluster
42-
2. Self managed OpenShift install using the `openshift-install` CLI. **REQUIRES ADDITIONAL CONFIGURATION**
44+
2. Self managed OpenShift install using the `openshift-install` CLI.
4345

46+
> [!IMPORTANT]
47+
> You need an external CA signed certificate for to be added (e.g. with let's encrypt) to a self-managed install
4448
4549
### `1.0.0`
4650
1.0.0 supports OpenShift Sandboxed containers version `1.8.1` along with Trustee version `0.2.0`.
@@ -70,22 +74,33 @@ It deploys a hello-openshift application 3 times:
7074
The instructions here presume you have a cluster. See further down for provisioning instructions for a cluster.
7175

7276
#### Fork and Clone the GitHub repo
73-
1. Following [standard validated patterns workflow](https://validatedpatterns.io/learn/workflow/) fork the repository and clone to your development enviroment which has `podman` and `git`
77+
1. Following [standard validated patterns workflow](https://validatedpatterns.io/learn/workflow/) fork the repository and clone to your development environment which has `podman` and `git`
7478
2. If using a particular version (e.g. `1.0.0`) checkout the correct tag.
7579

80+
> [!TIP]
81+
> Forking is essential as the validated pattern uses ArgoCD to reconcile it's state against your remote (forked) repository.
82+
7683

7784
#### Configuring required secrets / parameters
7885
The secrets here secure Trustee and the peer-pod vms. Mostly they are for demonstration purposes.
7986
This only has to be done once.
8087

8188
1. Run `sh scripts/gen-secrets.sh`
8289

90+
> [!NOTE]
91+
> Once generated this script will not override secrets. Be careful when doing multiple tests.
92+
8393
#### Check your cluster on Azure has a NAT gateway attached
8494
OpenShift does not require a NAT gateway by default, however, peer-pods do require a NAT gateway attached to the worker node subnet.
8595

86-
96+
> [!NOTE]
97+
>
8798
#### Configuring let's encrypt.
8899

100+
> [!IMPORTANT]
101+
> Ensure you have password login available to the cluster. Let's encrypt will replace the API certificate in addition to the certificates to user with routes.
102+
103+
89104
Trustee requires a trusted CA issued certificate. Let's Encrypt is included for environments without a trusted cert on OpenShift's routes.
90105

91106
If you need a Let's Encrypt certificate to be issued the `letsencrypt` application configuration needs to be changed as below.
@@ -114,11 +129,14 @@ If you need a Let's Encrypt certificate to be issued the `letsencrypt` applicati
114129
value: true
115130
```
116131
117-
This *must* first be pushed before deploying the pattern onto the cluster
132+
> [!WARNING]
133+
> Configuration changes are only effective once committed and pushed to your remote repository.
118134
119135
#### Installing onto a cluster
120136
Once you configuration is pushed (if required) `./pattern.sh make install` to provision a cluster.
121137

138+
> [!TIP]
139+
> The branch and default origin you have checked-out in your local repository is used to determine what ArgoCD and the patterns operator should reconcile against. Typical choices are to use the main for your fork.
122140

123141
## Cluster setup (if not already setup)
124142

0 commit comments

Comments
 (0)