You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-5Lines changed: 23 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,9 @@ Future work includes:
26
26
- Only known to work today with everything on one cluster. The work to expand this is in flight.
27
27
- If not using ARO you must either provide your own CA signed certs, or use let's encrypt.
28
28
- 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.
30
32
31
33
## Major versions
32
34
@@ -39,8 +41,10 @@ This limits support to OpenShift 4.16 and higher.
39
41
40
42
The pattern has been tested on Azure for two installation methods:
41
43
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.
43
45
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
44
48
45
49
### `1.0.0`
46
50
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:
70
74
The instructions here presume you have a cluster. See further down for provisioning instructions for a cluster.
71
75
72
76
#### 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`
74
78
2. If using a particular version (e.g. `1.0.0`) checkout the correct tag.
75
79
80
+
> [!TIP]
81
+
> Forking is essential as the validated pattern uses ArgoCD to reconcile it's state against your remote (forked) repository.
82
+
76
83
77
84
#### Configuring required secrets / parameters
78
85
The secrets here secure Trustee and the peer-pod vms. Mostly they are for demonstration purposes.
79
86
This only has to be done once.
80
87
81
88
1. Run `sh scripts/gen-secrets.sh`
82
89
90
+
> [!NOTE]
91
+
> Once generated this script will not override secrets. Be careful when doing multiple tests.
92
+
83
93
#### Check your cluster on Azure has a NAT gateway attached
84
94
OpenShift does not require a NAT gateway by default, however, peer-pods do require a NAT gateway attached to the worker node subnet.
85
95
86
-
96
+
> [!NOTE]
97
+
>
87
98
#### Configuring let's encrypt.
88
99
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
+
89
104
Trustee requires a trusted CA issued certificate. Let's Encrypt is included for environments without a trusted cert on OpenShift's routes.
90
105
91
106
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
114
129
value: true
115
130
```
116
131
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.
118
134
119
135
#### Installing onto a cluster
120
136
Once you configuration is pushed (if required) `./pattern.sh make install` to provision a cluster.
121
137
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.
0 commit comments