mirror of
https://github.com/ClusterCockpit/cc-docker.git
synced 2025-03-15 11:25:56 +01:00
Updated README for latest collection of services
This commit is contained in:
Aditya Ujeniya
parent
37dbd36c0f
commit
4ba14d8db7
162
README.md
162
README.md
@ -1,30 +1,27 @@
|
||||
# cc-docker
|
||||
|
||||
This is a `docker-compose` setup which provides a quickly started environment for ClusterCockpit development and testing, using `cc-backend`.
|
||||
A number of services is readily available as docker container (nats, cc-metric-store, InfluxDB, LDAP), or easily added by manual configuration (MySQL).
|
||||
A number of services is readily available as docker container (nats, cc-metric-store, InfluxDB, LDAP, SLURM), or easily added by manual configuration (MariaDB).
|
||||
|
||||
It includes the following containers:
|
||||
* nats (Default)
|
||||
* cc-metric-store (Default)
|
||||
* influxdb (Default)
|
||||
* openldap (Default)
|
||||
* mysql (Optional)
|
||||
* mariadb (Optional)
|
||||
* phpmyadmin (Optional)
|
||||
|Service full name|docker service name|port|
|
||||
| --- | --- | --- |
|
||||
|Slurm Controller service|slurmctld|6818|
|
||||
|Slurm Database service|slurmdbd|6817|
|
||||
|Slurm Rest service with JWT authentication|slurmrestd|6820|
|
||||
|Slurm Worker|node01|6818|
|
||||
|MariaDB service|mariadb|3306|
|
||||
|InfluxDB serice|influxdb|8086|
|
||||
|NATS service|nats|4222|
|
||||
|cc-metric-store service|cc-metric-store|8084|
|
||||
|OpenLDAP|openldap|389, 636|
|
||||
|
||||
The setup comes with fixture data for a Job archive, cc-metric-store checkpoints, InfluxDB, MySQL, and a LDAP user directory.
|
||||
|
||||
## Known Issues
|
||||
|
||||
* `docker-compose` installed on Ubuntu (18.04, 20.04) via `apt-get` can not correctly parse `docker-compose.yml` due to version differences. Install latest version of `docker-compose` from https://docs.docker.com/compose/install/ instead.
|
||||
* You need to ensure that no other web server is running on ports 8080 (cc-backend), 8081 (phpmyadmin), 8084 (cc-metric-store), 8086 (nfluxDB), 4222 and 8222 (Nats), or 3306 (MySQL). If one or more ports are already in use, you habe to adapt the related config accordingly.
|
||||
* Existing VPN connections sometimes cause problems with docker. If `docker-compose` does not start up correctly, try disabling any active VPN connection. Refer to https://stackoverflow.com/questions/45692255/how-make-openvpn-work-with-docker for further information.
|
||||
The setup comes with fixture data for a Job archive, cc-metric-store checkpoints, InfluxDB, MariaDB, and a LDAP user directory.
|
||||
|
||||
## Configuration Templates
|
||||
|
||||
Located in `./templates`
|
||||
* `docker-compose.yml.default`: Docker-Compose file to setup cc-metric-store, InfluxDB, MariaDB, PhpMyadmin, and LDAP containers (Default). Used in `setupDev.sh`.
|
||||
* `docker-compose.yml.mysql`: Docker-Compose configuration template if MySQL is desired instead of MariaDB.
|
||||
* `env.default`: Environment variables for setup with cc-metric-store, InfluxDB, MariaDB, PhpMyadmin, and LDAP containers (Default). Used in `setupDev.sh`.
|
||||
* `env.mysql`: Additional environment variables required if MySQL is desired instead of MariaDB.
|
||||
|
||||
@ -32,43 +29,128 @@ Located in `./templates`
|
||||
|
||||
1. Clone `cc-backend` repository in chosen base folder: `$> git clone https://github.com/ClusterCockpit/cc-backend.git`
|
||||
|
||||
2. Run `$ ./setupDev.sh`: **NOTICE** The script will download files of a total size of 338MB (mostly for the InfluxDB data).
|
||||
2. Run `$ ./setupDev.sh`: **NOTICE** The script will download files of a total size of 338MB (mostly for the cc-metric-store data).
|
||||
|
||||
3. The setup-script launches the supporting container stack in the background automatically if everything went well. Run `$> ./cc-backend/cc-backend` to start `cc-backend.`
|
||||
3. The setup-script launches the supporting container stack in the background automatically if everything went well. Run `$> ./cc-backend/cc-backend -server -dev` to start `cc-backend`.
|
||||
|
||||
4. By default, you can access `cc-backend` in your browser at `http://localhost:8080`. You can shut down the cc-backend server by pressing `CTRL-C`, remember to also shut down all containers via `$> docker-compose down` afterwards.
|
||||
|
||||
5. You can restart the containers with: `$> docker-compose up -d`.
|
||||
|
||||
## Post-Setup Adjustment for using `influxdb`
|
||||
|
||||
When using `influxdb` as a metric database, one must adjust the following files:
|
||||
* `cc-backend/var/job-archive/emmy/cluster.json`
|
||||
* `cc-backend/var/job-archive/woody/cluster.json`
|
||||
|
||||
In the JSON, exchange the content of the `metricDataRepository`-Entry (By default configured for `cc-metric-store`) with:
|
||||
```
|
||||
"metricDataRepository": {
|
||||
"kind": "influxdb",
|
||||
"url": "http://localhost:8086",
|
||||
"token": "egLfcf7fx0FESqFYU3RpAAbj",
|
||||
"bucket": "ClusterCockpit",
|
||||
"org": "ClusterCockpit",
|
||||
"skiptls": false
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
## Credentials for logging into clustercockpit
|
||||
|
||||
Credentials for the preconfigured demo user are:
|
||||
* User: `demo`
|
||||
* Password: `AdminDev`
|
||||
* Password: `demo`
|
||||
|
||||
You can also login as regular user using any credential in the LDAP user directory at `./data/ldap/users.ldif`.
|
||||
|
||||
## Post-Setup adjustment for using `cc-metric-store`
|
||||
|
||||
When using `influxdb` as a metric database, one must adjust the following files:
|
||||
* `cc-backend/var/job-archive/fritz/cluster.json`
|
||||
* `cc-backend/var/job-archive/alex/cluster.json`
|
||||
|
||||
In the JSON (cc-backend/config.json), exchange the content of the `metricDataRepository`-Entry (By default configured for `cc-metric-store`) with:
|
||||
```
|
||||
"metricDataRepository":
|
||||
{
|
||||
"kind": "cc-metric-store",
|
||||
"url": "http://localhost:8082",
|
||||
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFZERTQSJ9.eyJ1c2VyIjoiYWRtaW4iLCJyb2xlcyI6WyJST0xFX0FETUlOIiwiUk9MRV9BTkFMWVNUIiwiUk9MRV9VU0VSIl19.d-3_3FZTsadPjDEdsWrrQ7nS0edMAR4zjl-eK7rJU3HziNBfI9PDHDIpJVHTNN5E5SlLGLFXctWyKAkwhXL-Dw"
|
||||
}
|
||||
```
|
||||
|
||||
## Docker commands to access the services
|
||||
|
||||
> Note: You need to be in cc-docker directory in order to execute any docker command
|
||||
|
||||
You can view all docker processes running on either of the VM instance by using this command:
|
||||
|
||||
```
|
||||
$ docker ps
|
||||
```
|
||||
|
||||
Now that you can see the docker services, and if you want to manually access the docker services, you have to run **`bash`** command in those running services.
|
||||
|
||||
> **`Example`**: You want to run slurm commands like `sinfo` or `squeue` or `scontrol` on slurm controller, you cannot directly access it.
|
||||
|
||||
You need to **`bash`** into the running service by using the following command:
|
||||
|
||||
```
|
||||
$ docker exec -it <docker service name> bash
|
||||
|
||||
#example
|
||||
$ docker exec -it slurmctld bash
|
||||
|
||||
#or
|
||||
$ docker exec -it mariadb bash
|
||||
```
|
||||
|
||||
Once you start a **`bash`** on any docker service, then you may execute any service related commands in that **`bash`**.
|
||||
|
||||
But for Cluster Cockpit development, you only need ports to access these docker services. You have to use `localhost:<port>` when trying to access any docker service. You may need to configure the `cc-backend/config.json` based on these docker services and ports.
|
||||
|
||||
## Slurm setup in cc-docker
|
||||
|
||||
### 1. Slurm controller
|
||||
|
||||
Currently slurm controller is aware of the 1 node that we have setup in our mini cluster i.e. node01.
|
||||
|
||||
In order to execute slurm commands, you may need to **`bash`** into the **`slurmctld`** docker service.
|
||||
|
||||
```
|
||||
$ docker exec -it slurmctld bash
|
||||
```
|
||||
|
||||
Then you may be able to run slurm controller commands. A few examples without output are:
|
||||
|
||||
```
|
||||
$ sinfo
|
||||
|
||||
or
|
||||
|
||||
$ squeue
|
||||
|
||||
or
|
||||
|
||||
$ scontrol show nodes
|
||||
```
|
||||
|
||||
### 2. Slurm rest service
|
||||
|
||||
You do not need to **`bash`** into the slurmrestd service but can directly access the rest API via localhost:6820. A simple example on how to CURL to the slurm rest API is given in the `curl_slurmrestd.sh`.
|
||||
|
||||
You can directly use `curl_slurmrestd.sh` with a never expiring JWT token ( can be found in /data/slurm/secret/jwt_token.txt )
|
||||
|
||||
You may also use the never expiring token directly from the file for any of your custom CURL commands.
|
||||
|
||||
## Known Issues
|
||||
|
||||
* `docker-compose` installed on Ubuntu (18.04, 20.04) via `apt-get` can not correctly parse `docker-compose.yml` due to version differences. Install latest version of `docker-compose` from https://docs.docker.com/compose/install/ instead.
|
||||
* You need to ensure that no other web server is running on ports 8080 (cc-backend), 8082 (cc-metric-store), 8086 (InfluxDB), 4222 and 8222 (Nats), or 3306 (MariaDB). If one or more ports are already in use, you have to adapt the related config accordingly.
|
||||
* Existing VPN connections sometimes cause problems with docker. If `docker-compose` does not start up correctly, try disabling any active VPN connection. Refer to https://stackoverflow.com/questions/45692255/how-make-openvpn-work-with-docker for further information.
|
||||
|
||||
## Docker services and restarting the services
|
||||
|
||||
You can find all the docker services in `docker-compose.yml`. Feel free to modify it.
|
||||
|
||||
Whenever you modify it, please use
|
||||
|
||||
```
|
||||
$ docker compose down
|
||||
```
|
||||
|
||||
in order to shut down all the services in all the VM’s (maininstance, nodeinstance, nodeinstance2) and then start all the services by using
|
||||
|
||||
```
|
||||
$ docker compose up
|
||||
```
|
||||
|
||||
|
||||
|
||||
TODO: Update job archive and all other metric data.
|
||||
The job archive with 1867 jobs originates from the second half of 2020.
|
||||
Roughly 2700 jobs from the first week of 2021 are loaded with data from InfluxDB.
|
||||
Some views of ClusterCockpit (e.g. the Users view) show the last week or month.
|
||||
To show some data there you have to set the filter to time periods with jobs (August 2020 to January 2021).
|
||||
To show some data there you have to set the filter to time periods with jobs (August 2020 to January 2021).
|
||||
Loading…
x
Reference in New Issue
Block a user