diff --git a/README.md b/README.md index 2ef3680..0799bd9 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Layout and styling are based on [Bootstrap 5](https://getbootstrap.com/) using The backend uses [SQLite 3](https://sqlite.org/) as a relational SQL database by default. Optionally it can use a MySQL/MariaDB database server. While there are -metric data backends for the InfluxDB and Prometheus time series databases, the +metric data backends for the InfluxDB and Prometheus time series databases, the only tested and supported setup is to use cc-metric-store as the metric data backend. Documentation on how to integrate ClusterCockpit with other time series databases will be added in the future. @@ -72,7 +72,7 @@ You can also try the demo using the latest release binary. Create a folder and put the release binary `cc-backend` into this folder. Execute the following steps: -``` shell +```shell ./cc-backend -init vim config.json (Add a second cluster entry and name the clusters alex and fritz) wget https://hpc-mover.rrze.uni-erlangen.de/HPC-Data/0x7b58aefb/eig7ahyo6fo2bais0ephuf2aitohv1ai/job-archive-demo.tar @@ -91,11 +91,11 @@ Analysis, Systems and Status views). There is a Makefile to automate the build of cc-backend. The Makefile supports the following targets: -* `make`: Initialize `var` directory and build svelte frontend and backend -binary. Note that there is no proper prerequisite handling. Any change of -frontend source files will result in a complete rebuild. -* `make clean`: Clean go build cache and remove binary. -* `make test`: Run the tests that are also run in the GitHub workflow setup. +- `make`: Initialize `var` directory and build svelte frontend and backend + binary. Note that there is no proper prerequisite handling. Any change of + frontend source files will result in a complete rebuild. +- `make clean`: Clean go build cache and remove binary. +- `make test`: Run the tests that are also run in the GitHub workflow setup. A common workflow for setting up cc-backend from scratch is: @@ -131,41 +131,41 @@ ln -s ./var/job-archive ## Project file structure -* [`api/`](https://github.com/ClusterCockpit/cc-backend/tree/master/api) -contains the API schema files for the REST and GraphQL APIs. The REST API is -documented in the OpenAPI 3.0 format in -[./api/openapi.yaml](./api/openapi.yaml). -* [`cmd/cc-backend`](https://github.com/ClusterCockpit/cc-backend/tree/master/cmd/cc-backend) -contains `main.go` for the main application. -* [`configs/`](https://github.com/ClusterCockpit/cc-backend/tree/master/configs) -contains documentation about configuration and command line options and required -environment variables. A sample configuration file is provided. -* [`docs/`](https://github.com/ClusterCockpit/cc-backend/tree/master/docs) -contains more in-depth documentation. -* [`init/`](https://github.com/ClusterCockpit/cc-backend/tree/master/init) -contains an example of setting up systemd for production use. -* [`internal/`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal) -contains library source code that is not intended for use by others. -* [`pkg/`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg) -contains Go packages that can be used by other projects. -* [`tools/`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools) -Additional command line helper tools. - * [`archive-manager`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/archive-manager) - Commands for getting infos about and existing job archive. - * [`convert-pem-pubkey`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/convert-pem-pubkey) - Tool to convert external pubkey for use in `cc-backend`. - * [`gen-keypair`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/gen-keypair) - contains a small application to generate a compatible JWT keypair. You find - documentation on how to use it - [here](https://github.com/ClusterCockpit/cc-backend/blob/master/docs/JWT-Handling.md). -* [`web/`](https://github.com/ClusterCockpit/cc-backend/tree/master/web) -Server-side templates and frontend-related files: - * [`frontend`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/frontend) - Svelte components and static assets for the frontend UI - * [`templates`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/templates) - Server-side Go templates -* [`gqlgen.yml`](https://github.com/ClusterCockpit/cc-backend/blob/master/gqlgen.yml) -Configures the behaviour and generation of -[gqlgen](https://github.com/99designs/gqlgen). -* [`startDemo.sh`](https://github.com/ClusterCockpit/cc-backend/blob/master/startDemo.sh) -is a shell script that sets up demo data, and builds and starts `cc-backend`. +- [`api/`](https://github.com/ClusterCockpit/cc-backend/tree/master/api) + contains the API schema files for the REST and GraphQL APIs. The REST API is + documented in the OpenAPI 3.0 format in + [./api/openapi.yaml](./api/openapi.yaml). +- [`cmd/cc-backend`](https://github.com/ClusterCockpit/cc-backend/tree/master/cmd/cc-backend) + contains `main.go` for the main application. +- [`configs/`](https://github.com/ClusterCockpit/cc-backend/tree/master/configs) + contains documentation about configuration and command line options and required + environment variables. A sample configuration file is provided. +- [`docs/`](https://github.com/ClusterCockpit/cc-backend/tree/master/docs) + contains more in-depth documentation. +- [`init/`](https://github.com/ClusterCockpit/cc-backend/tree/master/init) + contains an example of setting up systemd for production use. +- [`internal/`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal) + contains library source code that is not intended for use by others. +- [`pkg/`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg) + contains Go packages that can be used by other projects. +- [`tools/`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools) + Additional command line helper tools. + - [`archive-manager`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/archive-manager) + Commands for getting infos about and existing job archive. + - [`convert-pem-pubkey`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/convert-pem-pubkey) + Tool to convert external pubkey for use in `cc-backend`. + - [`gen-keypair`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/gen-keypair) + contains a small application to generate a compatible JWT keypair. You find + documentation on how to use it + [here](https://github.com/ClusterCockpit/cc-backend/blob/master/docs/JWT-Handling.md). +- [`web/`](https://github.com/ClusterCockpit/cc-backend/tree/master/web) + Server-side templates and frontend-related files: + - [`frontend`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/frontend) + Svelte components and static assets for the frontend UI + - [`templates`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/templates) + Server-side Go templates +- [`gqlgen.yml`](https://github.com/ClusterCockpit/cc-backend/blob/master/gqlgen.yml) + Configures the behaviour and generation of + [gqlgen](https://github.com/99designs/gqlgen). +- [`startDemo.sh`](https://github.com/ClusterCockpit/cc-backend/blob/master/startDemo.sh) + is a shell script that sets up demo data, and builds and starts `cc-backend`.