Environments
Test environment
To showcase the functionalities of the Splunk Self Service Portal, there is a test environment. At the moment, the test environment is only tested on linux. Before you can use it, you have to install some dependencies:
podmanmake
The test environment is using Podman, because on the newer versions of some linux distributions, Docker is no usable because it lacks CgroupS v2 compability. Neverless if you have to use docker, you can make it working with setting additional environment variables for the backend.
Addionally to the software, you also have to make an entry in your /tec/hosts file. The test environment is using self signed certificates for the URL test.sssp.local. If you run Podman on your local machine you have to add the URL to your locahost entry.
127.0.0.1 localhost localhost.localdomain test.sssp.local gitlab.sssp.local
After that, just run the following command:
make test-run
This take takes more than six minutes. There is a timeout in the Makefile, so does Gitlab can boot proper.
To remove the test environment use this command:
make test-stop
Keep in mind, you cannot use a test and a development environemnt at the same time.
After everything is up and running. You can access the software on https://test.sssp.local:8000/. The test environment comes with default users. The default mongodb user and password can you get from the makefile.
This are hardcoded passphrases. Please do not use this in production!!
| Software | Username | Password | Additional Information |
|---|---|---|---|
| LDAP only | cn=admin,dc=rwicht,dc=ch | admin | |
| Systemwide using LDAP (Gitlab, Keycloak, SSSP) | test1 | Welcome.2020 | SSSP Admin User |
| test2 | Welcome.2020 | SSSP Standard User | |
| Keycloak only | root | Welcome.2020 | For the keycloak admin interface |
| Gitlab only | root | Welcome.2020 | Contains the repositories for the SSSP |
Devlopment environment
The dependencies are the same as in the build image section. The rest is nearly the same as in the test environment section. The only difference are the commands used to start and stop the environment.
make dev-run
make dev-stop
Just keep in mind, if you do not use all the containers, just start them independently using:
make def-<name of component>
When all servers are up, you can just make your changes in the sssp-client and sssp-server folder. Both directory are mounted in the container. When any changes are detected the deamons in the containers will automatically restart. Thanks to hot reload, the changes are directly visible in the frontend and you do not have to reload the page :).
There is a possible issue, with the sssp-server container. Nodemon can only watch a certain number of files. Because of the node modules, this number has been exceeded. The number can be increased permanently with the following command:
echo fs.inotify.max_user_watches=582222 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
After this, restart the container:
make dev-refresh-server