|
1 | 1 | # NOTE |
2 | 2 |
|
3 | | -While we do our best to keep the master branch in a usable state, there is no guarantee the master branch works. |
4 | | -Please do not use it for production! |
| 3 | +While we do our best to keep the main branch in a usable state, there is no |
| 4 | +guarantee the main branch works. Please do not use it for production! |
5 | 5 |
|
6 | | -Please have a look at the [Release |
7 | | -Notes](https://github.com/ClusterCockpit/cc-backend/blob/master/ReleaseNotes.md) |
| 6 | +Please have a look at the [Release Notes](https://github.com/ClusterCockpit/cc-backend/blob/main/ReleaseNotes.md) |
8 | 7 | for breaking changes! |
9 | 8 |
|
10 | 9 | # ClusterCockpit REST and GraphQL API backend |
@@ -41,7 +40,7 @@ For real-time integration with HPC systems, the backend can subscribe to |
41 | 40 | state updates, providing an alternative to REST API polling. |
42 | 41 |
|
43 | 42 | Completed batch jobs are stored in a file-based job archive according to |
44 | | -[this specification](https://github.com/ClusterCockpit/cc-specifications/tree/master/job-archive). |
| 43 | +[this specification](https://github.com/ClusterCockpit/cc-specifications/tree/main/job-archive). |
45 | 44 | The backend supports authentication via local accounts, an external LDAP |
46 | 45 | directory, and JWT tokens. Authorization for APIs is implemented with |
47 | 46 | [JWT](https://jwt.io/) tokens created with public/private key encryption. |
@@ -243,73 +242,73 @@ The effective configuration is logged at startup for verification. |
243 | 242 |
|
244 | 243 | ## Project file structure |
245 | 244 |
|
246 | | -- [`.github/`](https://github.com/ClusterCockpit/cc-backend/tree/master/.github) |
| 245 | +- [`.github/`](https://github.com/ClusterCockpit/cc-backend/tree/main/.github) |
247 | 246 | GitHub Actions workflows and dependabot configuration for CI/CD. |
248 | | -- [`api/`](https://github.com/ClusterCockpit/cc-backend/tree/master/api) |
| 247 | +- [`api/`](https://github.com/ClusterCockpit/cc-backend/tree/main/api) |
249 | 248 | contains the API schema files for the REST and GraphQL APIs. The REST API is |
250 | 249 | documented in the OpenAPI 3.0 format in |
251 | 250 | [./api/swagger.yaml](./api/swagger.yaml). The GraphQL schema is in |
252 | 251 | [./api/schema.graphqls](./api/schema.graphqls). |
253 | | -- [`cmd/cc-backend`](https://github.com/ClusterCockpit/cc-backend/tree/master/cmd/cc-backend) |
| 252 | +- [`cmd/cc-backend`](https://github.com/ClusterCockpit/cc-backend/tree/main/cmd/cc-backend) |
254 | 253 | contains the main application entry point and CLI implementation. |
255 | | -- [`configs/`](https://github.com/ClusterCockpit/cc-backend/tree/master/configs) |
| 254 | +- [`configs/`](https://github.com/ClusterCockpit/cc-backend/tree/main/configs) |
256 | 255 | contains documentation about configuration and command line options and required |
257 | 256 | environment variables. Sample configuration files are provided. |
258 | | -- [`init/`](https://github.com/ClusterCockpit/cc-backend/tree/master/init) |
| 257 | +- [`init/`](https://github.com/ClusterCockpit/cc-backend/tree/main/init) |
259 | 258 | contains an example of setting up systemd for production use. |
260 | | -- [`internal/`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal) |
| 259 | +- [`internal/`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal) |
261 | 260 | contains library source code that is not intended for use by others. |
262 | | - - [`api`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/api) |
| 261 | + - [`api`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/api) |
263 | 262 | REST API handlers and NATS integration |
264 | | - - [`archiver`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/archiver) |
| 263 | + - [`archiver`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/archiver) |
265 | 264 | Job archiving functionality |
266 | | - - [`auth`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/auth) |
| 265 | + - [`auth`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/auth) |
267 | 266 | Authentication (local, LDAP, OIDC) and JWT token handling |
268 | | - - [`config`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/config) |
| 267 | + - [`config`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/config) |
269 | 268 | Configuration management and validation |
270 | | - - [`graph`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/graph) |
| 269 | + - [`graph`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/graph) |
271 | 270 | GraphQL schema and resolvers |
272 | | - - [`importer`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/importer) |
| 271 | + - [`importer`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/importer) |
273 | 272 | Job data import and database initialization |
274 | | - - [`metricdispatch`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/metricdispatch) |
| 273 | + - [`metricdispatch`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/metricdispatch) |
275 | 274 | Dispatches metric data loading to appropriate backends |
276 | | - - [`repository`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/repository) |
| 275 | + - [`repository`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/repository) |
277 | 276 | Database repository layer for jobs and metadata |
278 | | - - [`routerConfig`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/routerConfig) |
| 277 | + - [`routerConfig`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/routerConfig) |
279 | 278 | HTTP router configuration and middleware |
280 | | - - [`tagger`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/tagger) |
| 279 | + - [`tagger`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/tagger) |
281 | 280 | Job classification and application detection |
282 | | - - [`taskmanager`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/taskmanager) |
| 281 | + - [`taskmanager`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/taskmanager) |
283 | 282 | Background task management and scheduled jobs |
284 | | - - [`metricstoreclient`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/metricstoreclient) |
| 283 | + - [`metricstoreclient`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/metricstoreclient) |
285 | 284 | Client for cc-metric-store queries |
286 | | -- [`pkg/`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg) |
| 285 | +- [`pkg/`](https://github.com/ClusterCockpit/cc-backend/tree/main/pkg) |
287 | 286 | contains Go packages that can be used by other projects. |
288 | | - - [`archive`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg/archive) |
| 287 | + - [`archive`](https://github.com/ClusterCockpit/cc-backend/tree/main/pkg/archive) |
289 | 288 | Job archive backend implementations (filesystem, S3, SQLite) |
290 | | - - [`metricstore`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg/metricstore) |
| 289 | + - [`metricstore`](https://github.com/ClusterCockpit/cc-backend/tree/main/pkg/metricstore) |
291 | 290 | In-memory metric data store with checkpointing and metric loading |
292 | | -- [`tools/`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools) |
| 291 | +- [`tools/`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools) |
293 | 292 | Additional command line helper tools. |
294 | | - - [`archive-manager`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/archive-manager) |
| 293 | + - [`archive-manager`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/archive-manager) |
295 | 294 | Commands for getting infos about an existing job archive, importing jobs |
296 | 295 | between archive backends, and converting archives between JSON and Parquet formats. |
297 | | - - [`archive-migration`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/archive-migration) |
| 296 | + - [`archive-migration`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/archive-migration) |
298 | 297 | Tool for migrating job archives between formats. |
299 | | - - [`convert-pem-pubkey`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/convert-pem-pubkey) |
| 298 | + - [`convert-pem-pubkey`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/convert-pem-pubkey) |
300 | 299 | Tool to convert external pubkey for use in `cc-backend`. |
301 | | - - [`gen-keypair`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/gen-keypair) |
| 300 | + - [`gen-keypair`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/gen-keypair) |
302 | 301 | contains a small application to generate a compatible JWT keypair. You find |
303 | 302 | documentation on how to use it |
304 | | - [here](https://github.com/ClusterCockpit/cc-backend/blob/master/docs/JWT-Handling.md). |
305 | | -- [`web/`](https://github.com/ClusterCockpit/cc-backend/tree/master/web) |
306 | | - Server-side templates and frontend-related files: |
307 | | - - [`frontend`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/frontend) |
| 303 | + [here](https://github.com/ClusterCockpit/cc-backend/blob/main/docs/JWT-Handling.md). |
| 304 | + - [`web/`](https://github.com/ClusterCockpit/cc-backend/tree/main/web) |
| 305 | + Server-side templates and frontend-related files: |
| 306 | + - [`frontend`](https://github.com/ClusterCockpit/cc-backend/tree/main/web/frontend) |
308 | 307 | Svelte components and static assets for the frontend UI |
309 | | - - [`templates`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/templates) |
| 308 | + - [`templates`](https://github.com/ClusterCockpit/cc-backend/tree/main/web/templates) |
310 | 309 | Server-side Go templates, including monitoring views |
311 | | -- [`gqlgen.yml`](https://github.com/ClusterCockpit/cc-backend/blob/master/gqlgen.yml) |
| 310 | +- [`gqlgen.yml`](https://github.com/ClusterCockpit/cc-backend/blob/main/gqlgen.yml) |
312 | 311 | Configures the behaviour and generation of |
313 | 312 | [gqlgen](https://github.com/99designs/gqlgen). |
314 | | -- [`startDemo.sh`](https://github.com/ClusterCockpit/cc-backend/blob/master/startDemo.sh) |
| 313 | +- [`startDemo.sh`](https://github.com/ClusterCockpit/cc-backend/blob/main/startDemo.sh) |
315 | 314 | is a shell script that sets up demo data, and builds and starts `cc-backend`. |
0 commit comments