Skip to content

Commit 9a2960a

Browse files
committed
Added development documentation
Signed-off-by: Andrew Block <[email protected]>
1 parent b429dd6 commit 9a2960a

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

DEVELOPMENT.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Development
2+
3+
This document describes recommended practices for developing and testing against this pattern.
4+
5+
## Testing Environments
6+
7+
While you may bring your own (BYO) OpenShift cluster, Red Hat associates and partners may utilize [Red Hat Demo Platform (RHDP)](https://catalog.demo.redhat.com) to provision OpenShift environments for use as targets for pattern development and testing.
8+
9+
### Provisioning
10+
11+
The following Catalog Item (CI) has been verified and is recommended when provisioning OpenShift clusters as it meets the prerequisites set form within the pattern:
12+
13+
* [Red Hat OpenShift Container Platform Cluster (AWS)](https://catalog.demo.redhat.com/catalog?item=babylon-catalog-prod/sandboxes-gpte.ocp-wksp.prod&utm_source=webapp&utm_medium=share-link)
14+
15+
The following options should be selected:
16+
* Activity: Practice / Enablement
17+
* Purpose: Trying out a technical solution
18+
* Salesforce ID: Can be omitted (See note below)
19+
* OpenShift Version: 4.19+
20+
* Features
21+
* Enable Cert Manager
22+
* Enable Cert Manager API
23+
* Control Plane Count: 3
24+
25+
Once a cluster has been provisioned, there are additional sets which need to be performed in order to avoid overlapping capabilities that are implemented within this pattern:
26+
27+
### Cert-Manager Removal
28+
29+
While cert-manager is a key feature offered within this pattern, RHDP deploys an instance to support the generation of API and Ingress certificates. Utilize the following steps to remove the conflicting resources.
30+
31+
1. Login to the Web Console of the provisioned OpenShift cluster with the provided authentication details.
32+
2. Under _Operators_ on the left hand navigation ad select **Installed Operators**
33+
3. Locate _cert-manager Operator for Red Hat OpenShift_ and click the kabob (3 vertical dots) from the right hand column and select **Uninstall Operator**
34+
4. The `OperatorGroup` associated with Cert Manager must also be uninstalled. Under _Home_ on the left hand navigation, select **API Explorer**
35+
5. From the project dropdown at the top of the screen, select `cert-manager-operator` as the _Project_
36+
6. In the search textbox, enter `OperatorGroup` and select the link underneath the _Name_ column associated with API Version `v1` in the _Version_ column.
37+
7. Click on the **Instances** tab
38+
8. Locate any instances and click the kabob (3 vertical dots) from the right hand column and select **Delete OperatorGroup**
39+
40+
## Analytics Tracking
41+
42+
Metrics are captured to track the use of any of the Validated Patterns. It is important than an accurate depiction of pattern use by customers, partners and those from the community are captured. Red Hat associates should not factor into this calculation and support is available in the Validated Patterns framework to opt out of being captured.
43+
44+
To implement the opt-out capability, create a file in the location `~/.config/validated-patterns/pattern-uuid`. The file does not need to have to be populated with any specific content. Its mere presence is all that is necessary for usage of the pattern to not be tracked.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,3 +201,7 @@ Switch back to the qtodo application and enter the username and password on the
201201
Once you have authenticated to RHBK, you will be instructed to change the temporary password and set a more permanent password. Once complete, you will be redirected to the qtodo application verifying the OIDC based authentication functions properly.
202202
203203
Feel free to add new items to the list of todos. By being able to add and remove items from the page, the integration between the Quarkus application and the backend PostgreSQL database using credentials sourced from HashiCorp Vault was successful.
204+
205+
## Development
206+
207+
Interested in developing capabilities for this pattern or performing tests against it? Head over to our [Developer Documentation](./DEVELOPMENT.md).

0 commit comments

Comments
 (0)