The Diamond Light Source developer portal, built with backstage for deployment on kubernetes.
docker-compose
module
, or:
systemctl --user start podman.socket
export DOCKER_HOST=unix:///run/user/$UID/podman/podman.sock
to your ~/.bashrc
ms-vscode-remote.remote-containers
remote.containers.dockerPath
to podman
remote.containers.dockerComposePath
to your docker-compose
export DOCKER_BUILDKIT=0
to your ~/.bashrc
.env
file in the .devcontainer
directory containing the necessary secretsyarn --cwd backstage install
yarn --cwd backstage dev
module load argus
charts/developer-portal/values.yaml
as appropriate, you will need to ingress secrets by either:
backend.auth
backend.auth.existingSecret
(recommended)Deploy the portal, with:
cd charts/developer-portal
helm install <deployment-name> .
In order to deploy this application, the following secrets are required
GITHUB_TOKEN
- a GitHub personal access token used to retrieve organisation & repository data, with:
read:org
read:user
user:email
GITLAB_TOKEN
- a GitLab personal access token used to retrieve organisation & repository data, with:
api
read_repository
write_repository
GITHUB_APP_CLIENT_ID
- a GitHub OAuth App client ID used to provide user authenticationGITHUB_APP_SECRET
- the corresponding GitHub OAuth App secretAWS_ACCESS_KEY_ID
- a AWS S3 bucket access key ID used to retrieve techdocs from the object store, with:
s3:ListBucket
s3:GetObject
AWS_SECRET_ACCESS_KEY
- the corresponding AWS S3 bucket access key secret