Skip to content

Docs: document deployment process for stellar-dashboard #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcelosalloum merged 2 commits into from
Mar 3, 2026
Merged

Docs: document deployment process for stellar-dashboard #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f56ecc
docs: add deployment section to README describing Jenkins approval + …
marcelosalloum Mar 3, 2026
97ab9bb
Update TECH_STACK_OVERVIEW.md
marcelosalloum Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,12 @@ Directions for creating a service account
Once you've created a service account, add the service account key json file to
the `gcloud` folder under the name `service-account.json`. An example json file
shows what the file structure should look like.

## Deployment

Merging to `main` does **not** auto-deploy. A maintainer must manually approve
the [Jenkins job](https://buildmeister-v3.stellar-ops.com/job/ProductEngineering/job/stellar-dashboard-k8s/)
before [ArgoCD](https://argo-prd-eks.stellar-ops.com/applications/stellar-dashboard-prd)
deploys to production. If the job timed out, restart it to trigger the approval
step again. Verify the deploy by checking ArgoCD shows **Synced/Healthy** and
confirming changes on [dashboard.stellar.org](https://dashboard.stellar.org).
6 changes: 5 additions & 1 deletion TECH_STACK_OVERVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,12 @@ This pins `ua-parser-js` to prevent dependency vulnerabilities.

### Deployment Platforms

- **Heroku**: Configured via `Procfile` and `heroku-postbuild` script
- **EKS**: Hosted on Amazon EKS (`stellar-dashboard-prd` cluster)
- **Docker**: `Dockerfile` available for containerized deployment
- **Jenkins**: Builds and pushes images via
[`ProductEngineering/stellar-dashboard-k8s`](https://buildmeister-v3.stellar-ops.com/job/ProductEngineering/job/stellar-dashboard-k8s/)
(requires manual approval)
- **ArgoCD**: Deploys approved images to the production cluster

### Environment

Expand Down
Loading