{"id":19541611,"url":"https://github.com/brigadecore/brigade-dashboard","last_synced_at":"2025-06-12T03:08:49.826Z","repository":{"id":37787441,"uuid":"464607581","full_name":"brigadecore/brigade-dashboard","owner":"brigadecore","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-03T00:02:47.000Z","size":1335,"stargazers_count":4,"open_issues_count":23,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-26T17:46:48.735Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brigadecore.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-28T18:59:50.000Z","updated_at":"2022-07-28T07:35:25.000Z","dependencies_parsed_at":"2024-11-11T03:11:27.535Z","dependency_job_id":"5664f812-663d-4938-b03f-f14cf33bca35","html_url":"https://github.com/brigadecore/brigade-dashboard","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/brigadecore/brigade-dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brigadecore%2Fbrigade-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brigadecore%2Fbrigade-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brigadecore%2Fbrigade-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brigadecore%2Fbrigade-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brigadecore","download_url":"https://codeload.github.com/brigadecore/brigade-dashboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brigadecore%2Fbrigade-dashboard/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259387761,"owners_count":22849750,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T03:11:16.320Z","updated_at":"2025-06-12T03:08:49.777Z","avatar_url":"https://github.com/brigadecore.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brigade Dashboard\n\n![build](https://badgr.brigade2.io/v1/github/checks/brigadecore/brigade-dashboard/badge.svg?appID=99005\u0026branch=main)\n[![slack](https://img.shields.io/badge/slack-brigade-brightgreen.svg?logo=slack)](https://slack.brigade.sh)\n\n\u003cimg width=\"100\" align=\"left\" src=\"logo.png\"\u003e\n\nThis is a _highly volatile prototype_ for a web-based, v2-compatible, Brigade\ndashboard.\n\n\nYour mileage may vary.\n\n\u003cbr clear=\"left\"/\u003e\n\n## Installation\n\n\u003e ⚠️\u0026nbsp;\u0026nbsp;Be sure you are using\n\u003e [Helm 3.7.0](https://github.com/helm/helm/releases/tag/v3.7.0) or greater and\n\u003e enable experimental OCI support:\n\u003e\n\u003e ```shell\n\u003e $ export HELM_EXPERIMENTAL_OCI=1\n\u003e ```\n\n1. As the dashboard requires some specific configuration, we'll first create a\n   values file containing those settings. Use the following command to extract\n   the full set of configuration options into a file you can modify:\n\n   ```shell\n   $ helm inspect values oci://ghcr.io/brigadecore/brigade-dashboard \\\n       --version v0.2.0 \u003e ~/brigade-dashboard-values.yaml\n   ```\n\n1. Edit `~/brigade-dashboard-values.yaml`, making the following changes:\n\n   * `brigade.apiAddress`: Set this to the address of the Brigade API server,\n     beginning with `https://`.\n\n   * `host`: Set this to the fully qualified domain name that will resolve to\n     the dashboard. If you do not intend to create a DNS entry for the\n     dashboard, you may ignore this field and leave its default value.\n\n   * `service.type`: If you plan to enable ingress (advanced) or you're\n     installing on a local, development-grade Kubernetes cluster that cannot\n     provision a public IP for the dashboard, you can leave this as its default\n     -- `ClusterIP`. If you are deploying the dashboard to a remote Kubernetes\n     cluster with intentions for the dashboard to be publicly accessible, you\n     should change this value to `LoadBalancer`.\n\n   \u003e ⚠️\u0026nbsp;\u0026nbsp;By default, TLS will be enabled and a self-signed certificate\n   \u003e will be generated.\n   \u003e\n   \u003e For a production-grade deployment you should explore the options available\n   \u003e for providing or provisioning a certificate signed by a trusted authority.\n   \u003e These options can be located under the `tls` and `ingress.tls` sections of\n   \u003e the values file.\n\n1. Save your changes to `~/brigade-dashboard-values.yaml`.\n\n1. Use the following command to install the dashboard:\n\n   ```shell\n   $ helm install brigade-dashboard \\\n       oci://ghcr.io/brigadecore/brigade-dashboard \\\n       --version v0.2.0 \\\n       --create-namespace \\\n       --namespace brigade-dashboard \\\n       --values ~/brigade-dashboard-values.yaml \\\n       --wait\n   ```\n\n## Accessing the Dashboard\n\nIf you have deployed the dashboard to a remote Kubernetes cluster, have _not_\nenabled ingress, and have set the value of `service.type` to `LoadBalancer`,\nyou may find the public IP of the dashboard with the following command:\n\n```shell\n$ kubectl get svc brigade-dashboard \\\n    --namespace brigade-dashboard \\\n    --output jsonpath='{.status.loadBalancer.ingress[0].ip}'\n```\n\nIf you overrode default configuration to enable support for an ingress\ncontroller, you probably know what you're doing well enough to track down the\ncorrect IP for that ingress controller without our help. 😉\n\nIf you have deployed the dashboard to a local, development-grade cluster, use\nthe following command to map a port on the local network interface to the\ndashboard:\n\n```shell\n$ kubectl port-forward svc/brigade-dashboard \\\n    --namespace brigade-dashboard \\\n    8443:443\n```\n\n## Contributing\n\nThe Brigade project accepts contributions via GitHub pull requests. The\n[Contributing](CONTRIBUTING.md) document outlines the process to help get your\ncontribution accepted.\n\n## Support \u0026 Feedback\n\nWe have a slack channel! [Kubernetes/#brigade](https://slack.brigade.sh) Feel\nfree to join for any support questions or feedback, we are happy to help. To\nreport an issue or to request a feature open an issue\n[here](https://github.com/brigadecore/brigade-dashboard/issues)\n\n## Code of Conduct\n\nParticipation in the Brigade project is governed by the\n[CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrigadecore%2Fbrigade-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrigadecore%2Fbrigade-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrigadecore%2Fbrigade-dashboard/lists"}