Skip to content

Commit

Permalink
chore: add instructions how to get started
Browse files Browse the repository at this point in the history
  • Loading branch information
leonsteinhaeuser committed Nov 18, 2024
1 parent b0ee8e1 commit 9c6b441
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,28 @@ Red Hat OpenShift application deployment examples.
- view # A demo service that displays the random number
```

## Prerequisites

- OpenShift >= 4.17 cluster
- Enabled GitOps subscription in the OpenShift cluster (ArgoCD)
- `oc` CLI installed and configured to access the OpenShift cluster

## How to deploy

Before we can deploy any of the services, we need to modify our central ArgoCD management application to allow sourcing `Application` resources from other than the `openshift-gitops` namespace. This is necessary because the services are deployed in a separate project, namespace and ArgoCD application.

To do this, execute the following patch command:

```bash
oc -n openshift-gitops patch argocds.argoproj.io openshift-gitops \
--type merge \
--patch '{"spec":{"sourceNamespaces":["openshift-gitops","example-application-basic","example-application-progressive"]}}'
```

The `openshift-gitops` namespace is the `default` namespace and might not be necessary to add to the `sourceNamespaces` list. However, it is added here for completeness.

### Deploy the services

1. Clone the repository

```bash
Expand Down

0 comments on commit 9c6b441

Please sign in to comment.