Skip to content

Commit

Permalink
updated README instructions
Browse files Browse the repository at this point in the history
fixed typo, added notes on yarn install and module load docker-compose
  • Loading branch information
M-Chan authored and garryod committed Dec 8, 2023
1 parent a5252e5 commit 9e1ba70
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,32 @@ The Diamond Light Source developer portal, built with backstage for deployment o

## Developing Locally (VSCode)

- [Install docker-compose](https://docs.docker.com/compose/install/other/)
- Start the podman socket with `systemctl --user start podman.socket`
- Use the podman socket as the compose host by adding `export DOCKER_HOST=unix:///run/user/$UID/podman/podman.sock` to your `~/.bashrc`
- Load the `docker-compose` `module`, or:
- [Install docker-compose](https://docs.docker.com/compose/install/other/),
- Start the podman socket with `systemctl --user start podman.socket`
- Use the podman socket as the compose host by adding `export DOCKER_HOST=unix:///run/user/$UID/podman/podman.sock` to your `~/.bashrc`
- Install `ms-vscode-remote.remote-containers`
- Set `remote.containers.dockerPath` to `podman`
- Set `remote.containers.dockerComposePath` to your `docker-compose`
- Disable buildkit by adding `export DOCKER_BUILDKIT=0` to your `~/.bashrc`
- Open Development Container
- Create a `.env` file in the `.devcontainer` directory containing the [nessacary secrets](#nessacary-secrets)
- Create a `.env` file in the `.devcontainer` directory containing the [necessary secrets](#necessary-secrets)
- Install package dependencies with `yarn --cwd backstage install`
- Start the app, with `yarn --cwd backstage dev`

## Deploying on Kubernetes (Diamond Light Source)

- Access the cluster with `module load argus`
- Adjust configuration in `charts/developer-portal/values.yaml` as appropriate, you will need to ingress secrets by either:
- Populating the [nessacary secrets](#nessacary-secrets) in their respective fields in `backend.auth`
- Pointing to an existing secret containing the [nessacary secrets](#nessacary-secrets) with `backend.auth.existingSecret` (recommended)
- Populating the [necessary secrets](#necessary-secrets) in their respective fields in `backend.auth`
- Pointing to an existing secret containing the [necessary secrets](#necessary-secrets) with `backend.auth.existingSecret` (recommended)
- Deploy the portal, with:
```sh
cd charts/developer-portal
helm install <deployment-name> .
```

## Nessacary secrets
## Necessary secrets

In order to deploy this application, the following secrets are required

Expand Down

0 comments on commit 9e1ba70

Please sign in to comment.