Skip to content

Commit 30d822e

Browse files
committed
fix: autofixed
Signed-off-by: Chris Butler <chris.butler@redhat.com>
1 parent 488a4d0 commit 30d822e

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Future work includes:
3030
## Major versions
3131

3232
### `2.*`
33+
3334
This is currently the `main` branch for the repository. Version 2.* of the pattern is currently constrained to support:
3435

3536
- (OpenShift Sandboxed Containers Operator) `1.9.*`
@@ -46,20 +47,23 @@ The pattern has been tested on Azure for two installation methods:
4647
> You need an external CA signed certificate for to be added (e.g. with let's encrypt) to a self-managed install
4748
4849
### `1.0.0`
50+
4951
1.0.0 supports OpenShift Sandboxed containers version `1.8.1` along with Trustee version `0.2.0`.
5052

5153
The pattern has been tested on Azure for one installation method:
5254

5355
1. Self managed OpenShift install using the `openshift-install` CLI
5456
2. Installing on top of an existing Azure Red Hat OpenShift (ARO) cluster
5557

56-
## Validated pattern flavours
57-
**Today the demo has one flavour**.
58+
## Validated pattern flavours
59+
60+
**Today the demo has one flavour**.
5861
A number are planned based on various different hub cluster-groups.
59-
You can change between behaviour by configuring [`global.main.clusterGroupName`](https://validatedpatterns.io/learn/values-files/) key in the `values-global.yaml` file.
62+
You can change between behaviour by configuring [`global.main.clusterGroupName`](https://validatedpatterns.io/learn/values-files/) key in the `values-global.yaml` file.
6063

6164
`values-simple.yaml`: or the `simple` cluster group is the default for the pattern.
62-
It deploys a hello-openshift application 3 times:
65+
It deploys a hello-openshift application 3 times:
66+
6367
- A standard pod
6468
- A kata container with peer-pods
6569
- A confidential kata-container
@@ -76,26 +80,27 @@ The instructions here presume you have a cluster. See further down for provision
7680
2. If using a particular version (e.g. `1.0.0`) checkout the correct tag.
7781

7882
> [!TIP]
79-
> Forking is essential as the validated pattern uses ArgoCD to reconcile it's state against your remote (forked) repository.
83+
> Forking is essential as the validated pattern uses ArgoCD to reconcile it's state against your remote (forked) repository.
8084
8185
#### Configuring required secrets / parameters
8286

83-
The secrets here secure Trustee and the peer-pod vms. Mostly they are for demonstration purposes.
87+
The secrets here secure Trustee and the peer-pod vms. Mostly they are for demonstration purposes.
8488
This only has to be done once.
8589

8690
1. Run `sh scripts/gen-secrets.sh`
8791

8892
> [!NOTE]
8993
> Once generated this script will not override secrets. Be careful when doing multiple tests.
9094
91-
#### Configuring let's encrypt.
95+
#### Configuring let's encrypt
9296

9397
> [!IMPORTANT]
9498
> 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.
9599
96100
Trustee requires a trusted CA issued certificate. Let's Encrypt is included for environments without a trusted cert on OpenShift's routes.
97101

98102
If you need a Let's Encrypt certificate to be issued the `letsencrypt` application configuration needs to be changed as below.
103+
99104
```yaml
100105
---
101106
# Default configuration, safe for ARO
@@ -140,13 +145,15 @@ Red Hat a demo platform. This allows easy access for Red Hat associates and part
140145
1. **NOTE: openshift installer must be updated regularly if you want to automatically provision the latest versions of OCP**
141146
2. Get access to an [Azure Subscription Based Blank Open Environment](https://catalog.demo.redhat.com/catalog?category=Open_Environments&search=azure&item=babylon-catalog-prod%2Fazure-gpte.open-environment-azure-subscription.prod).
142147
3. Import the required azure environmental variables (see coded block):
148+
143149
```shell
144150
export GUID=
145151
export CLIENT_ID=
146152
export PASSWORD=
147153
export TENANT=
148154
export SUBSCRIPTION=
149155
export RESOURCEGROUP=
156+
150157
```
151158
1. Ensure Let's encrypt
152159
1. Run the wrapper install script
@@ -171,12 +178,13 @@ Red Hat a demo platform. This allows easy access for Red Hat associates and part
171178
azure:
172179
type: Standard_D8s_v5
173180
```
181+
174182
1. `mkdir ./ocp-install && mv openshift-install.yaml ./ocp-install`
175183
2. `openshift-install create cluster --dir=./ocp-install`
176184
3. Once installed:
177-
1. Login to `oc`
178-
2. Configure Let's Encrypt (if required)
179-
3. `./pattern.sh make install`
185+
1. Login to `oc`
186+
2. Configure Let's Encrypt (if required)
187+
3. `./pattern.sh make install`
180188

181189
### Multi cluster setup
182190

rhdp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The scripts in this directory help users of that platform automate deployments.
99
2. Download the credentials
1010
3. Load the credentials into your environment (e.g. using `direnv`)
1111
4. Launch the wrapper script from the repository root directory:
12-
1. `bash ./rhdp/wrapper.sh eastasia`
12+
1. `bash ./rhdp/wrapper.sh eastasia`
1313
2. The wrapper script **requires** an azure region code this code SHOULD be the same as what was selected in RHDP.

0 commit comments

Comments
 (0)