{"id":28566984,"url":"https://github.com/altinity/altinity-dashboard","last_synced_at":"2025-06-10T15:40:48.469Z","repository":{"id":36984668,"uuid":"427207947","full_name":"Altinity/altinity-dashboard","owner":"Altinity","description":"Altinity Dashboard helps you manage ClickHouse installations controlled by clickhouse-operator.","archived":false,"fork":false,"pushed_at":"2025-06-10T02:08:33.000Z","size":14015,"stargazers_count":68,"open_issues_count":14,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-10T03:24:04.782Z","etag":null,"topics":["clickhouse","clickhouse-operator","console","kubernetes","management","ui"],"latest_commit_sha":null,"homepage":"","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/Altinity.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-11-12T02:30:10.000Z","updated_at":"2025-06-10T02:08:31.000Z","dependencies_parsed_at":"2024-05-10T02:32:20.175Z","dependency_job_id":"930968d7-e0e8-4719-b87c-c7d80b8e1e3c","html_url":"https://github.com/Altinity/altinity-dashboard","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Faltinity-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Faltinity-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Faltinity-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Faltinity-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Altinity","download_url":"https://codeload.github.com/Altinity/altinity-dashboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Faltinity-dashboard/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259104306,"owners_count":22805852,"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":["clickhouse","clickhouse-operator","console","kubernetes","management","ui"],"created_at":"2025-06-10T15:40:17.121Z","updated_at":"2025-06-10T15:40:48.447Z","avatar_url":"https://github.com/Altinity.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Altinity Dashboard\n\nThis is a preliminary version of the Altinity Dashboard.  It is used for viewing and managing Kubernetes-based ClickHouse installations controlled by [clickhouse-operator](https://github.com/altinity/clickhouse-operator).  It looks like this:\n\n![image](https://user-images.githubusercontent.com/2052848/146246541-4073218c-92be-4ccb-8a4d-b5bbc7f9a309.png)\n\n### What is this?\n\nThe Altinity Dashboard allows easy deployment and management of ClickHouse in Kubernetes, managed using the Altinity clickhouse-operator.  Using the dashboard, you can:\n\n* Deploy clickhouse-operator to your Kubernetes cluster.\n* Upgrade clickhouse-operator.\n* Remove clickhouse-operator.\n\n* Deploy a ClickHouse Installation from a YAML specification (examples are provided), including the ability to define the cluster layout, storage, users and other operational parameters.\n* Modify existing ClickHouse Installations, even if they were not created by the Dashboard (as long as they are managed by clickhouse-operator).\n\n* View containers and storage used by ClickHouse Installations, and their status.\n\n### Production Readiness\n\nCurrent builds of Altinity Dashboard should be considered pre-release, and are not ready for production deployment.  We are using an upstream-first open source development model, so you can see and run the code, but it is not yet a stable release.\n\n### How to Use\n\n* First, make sure you have a valid kubeconfig pointing to the Kubernetes cluster you want to work with.\n\n* Linux / Mac:\n  * Download the appropriate file for your platform from https://github.com/Altinity/altinity-dashboard/releases.\n  * `chmod a+x adash-linux-*`\n  * `./adash-linux-* --openbrowser`\n\n* Windows:\n  * Download and double-click on the Windows EXE file from https://github.com/Altinity/altinity-dashboard/releases.\n  * A command prompt window will open and will show a URL.\n  * Copy and paste the URL into a web browser.\n  * Windows SmartScreen Filter may warn that the EXE file is rarely downloaded.  You can ignore this.\n\n### Running the container image from the GitHub Container Registry\n\nContainer images are available on the GitHub Container Registry.  To use this:\n\n* Run `docker pull ghcr.io/altinity/altinity-dashboard:latest` to get the latest build of the container.\n* Run `docker run -it --rm ghcr.io/altinity/altinity-dashboard:latest adash --help`.  If everything is working, you should see command-line help.\n* If you run this container inside Kubernetes, it should perform in-cluster auth.\n* To run it outside Kubernetes, you will need to volume mount a kubeconfig file and use `-kubeconfig` to point to it.\n\n### Building from source\n\n* Install the following on your development system:\n  * [**Go**](https://golang.org/doc/install) 1.16 or higher\n  * [**Node.js**](https://nodejs.org/en/download/) v16 or higher, including npm 7.24 or higher\n  * **GNU Make** version 4.3 or higher (`yum/dnf/apt install make`)\n* Clone the repo (`git clone git@github.com:altinity/altinity-dashboard`).\n* Initialize submodules (`git submodule update --init --recursive`).\n* Run `make`.\n\nIf you are doing development work, it is recommended to install pre-commit hooks so that linters are run before commit.  To set this up:\n\n* Install [golangci-lint](https://github.com/golangci/golangci-lint#readme).\n* From the repo root, run `npm --prefix ./ui run install-git-hooks`.\n* Run `make lint` to check that everything is working.\n\n### Setting up a development environment\n\nBack-end development:\n\n* Set up your IDE to run `make ui` before compiling, so that the most recent UI gets embedded into the Go binary.  If nothing in the UI has changed, `make ui` will not re-run the build unnecessarily.\n* Run the app in the debugger with `adash -devmode`.  This will add a tab with [Swagger UI](https://swagger.io/tools/swagger-ui/) that lets you exercise REST endpoints even if there isn't a UI for them yet.\n\nFront-end development:\n\n* `make ui-devel` will start a filesystem watcher / hot reloader for UI development.\n\n### Talk to Us\n\nIf you have questions or want to chat, [join the altinitydb Slack](https://join.slack.com/t/altinitydbworkspace/shared_invite/zt-w6mpotc1-fTz9oYp0VM719DNye9UvrQ) and talk to us in the `#kubernetes` channel.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faltinity%2Faltinity-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faltinity%2Faltinity-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faltinity%2Faltinity-dashboard/lists"}