Skip to content

Commit 80f14a2

Browse files
committed
fix: more language fixes
Signed-off-by: Chris Butler <chris.butler@redhat.com>
1 parent ef41f51 commit 80f14a2

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ The target operating model has two clusters:
77
- One in a "trusted" zone where the remote attestation, KMS and Key Broker infrastructure are deployed.
88
- A second where a subset of workloads are deployed in confidential containers.
99

10-
**For the current version of this application the confidential containers assumes deployment to Azure**
10+
The current version of this application the confidential containers assumes deployment to Azure.
11+
12+
On the platform a sample workload is deployed:
1113

12-
On the platform a a sample workload is deployed:
13-
1414
1. Sample hello world applications to allow users to experiment with the policies for CoCo and the KBS (trustee).
1515
2. A sample application `kbs-access` which presents secrets obtained from trustee to a web service. This is designed to allow users to test locked down environments.
1616

@@ -31,12 +31,14 @@ Future work includes:
3131

3232
### `2.*`
3333
This is currently the `main` branch for the repository. Version 2.* of the pattern is currently constrained to support:
34+
3435
- (OpenShift Sandboxed Containers Operator) `1.9.*`
3536
- Trustee `0.3.*`
3637

3738
This limits support to OpenShift 4.16 and higher.
3839

3940
The pattern has been tested on Azure for two installation methods:
41+
4042
1. Installing onto an ARO cluster
4143
2. Self managed OpenShift install using the `openshift-install` CLI.
4244

@@ -47,9 +49,11 @@ The pattern has been tested on Azure for two installation methods:
4749
1.0.0 supports OpenShift Sandboxed containers version `1.8.1` along with Trustee version `0.2.0`.
4850

4951
The pattern has been tested on Azure for one installation method:
52+
5053
1. Self managed OpenShift install using the `openshift-install` CLI
54+
2. Installing on top of an existing Azure Red Hat OpenShift (ARO) cluster
5155

52-
## validated pattern flavours
56+
## Validated pattern flavours
5357
**Today the demo has one flavour**.
5458
A number are planned based on various different hub cluster-groups.
5559
You can change between behaviour by configuring [`global.main.clusterGroupName`](https://validatedpatterns.io/learn/values-files/) key in the `values-global.yaml` file.
@@ -67,13 +71,15 @@ It deploys a hello-openshift application 3 times:
6771
The instructions here presume you have a cluster. See further down for provisioning instructions for a cluster.
6872

6973
#### Fork and Clone the GitHub repo
74+
7075
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`
7176
2. If using a particular version (e.g. `1.0.0`) checkout the correct tag.
7277

7378
> [!TIP]
7479
> Forking is essential as the validated pattern uses ArgoCD to reconcile it's state against your remote (forked) repository.
7580
7681
#### Configuring required secrets / parameters
82+
7783
The secrets here secure Trustee and the peer-pod vms. Mostly they are for demonstration purposes.
7884
This only has to be done once.
7985

@@ -118,7 +124,8 @@ If you need a Let's Encrypt certificate to be issued the `letsencrypt` applicati
118124
> Configuration changes are only effective once committed and pushed to your remote repository.
119125
120126
#### Installing onto a cluster
121-
Once you configuration is pushed (if required) `./pattern.sh make install` to provision a cluster.
127+
128+
Once you configuration is pushed (if required) `./pattern.sh make install` to provision a cluster.
122129

123130
> [!TIP]
124131
> 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.
@@ -128,11 +135,12 @@ Once you configuration is pushed (if required) `./pattern.sh make install` to pr
128135
### Single cluster install on an OCP cluster on azure using Red Hat Demo Platform
129136

130137
Red Hat a demo platform. This allows easy access for Red Hat associates and partners to ephemeral cloud resources. The pattern is known to work with this setup.
138+
131139
1. Get the [openshift installer](https://console.redhat.com/openshift/downloads)
132140
1. **NOTE: openshift installer must be updated regularly if you want to automatically provision the latest versions of OCP**
133141
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).
134142
3. Import the required azure environmental variables (see coded block):
135-
```
143+
```shell
136144
export GUID=
137145
export CLIENT_ID=
138146
export PASSWORD=
@@ -148,6 +156,7 @@ Red Hat a demo platform. This allows easy access for Red Hat associates and part
148156
1. You *may* need to recreate the hello world peer-pods depending on timeouts.
149157

150158
### Single cluster install on plain old azure *not* using Red Hat Demo Platform
159+
151160
**NOTE: Don't use the default node sizes.. increase the node sizes such as below**
152161

153162
1. Login to console.redhat.com
@@ -170,4 +179,5 @@ Red Hat a demo platform. This allows easy access for Red Hat associates and part
170179
3. `./pattern.sh make install`
171180

172181
### Multi cluster setup
182+
173183
TBD

0 commit comments

Comments
 (0)