Commit c4446df3 authored by lukas.burgey's avatar lukas.burgey

Update the README.md

parent e4be4463
Pipeline #88099 passed with stages
in 52 seconds
FEUDAL Client
====
The feudal client execute the deployment and removal of feudal users to and from custom services.
Multiple feudal clients connect to one feudal backend. They clients are meant to be run in proximity of the service, e.g. on the same VM / cluster.
Feudal clients execute the deployment and removal of feudal users to and from custom services.
Multiple feudal clients connect to one feudal backend. The clients are meant to be run in proximity of the service, e.g. on the same VM / cluster.
Building
----
- Have a go version newer than 1.12 installed: ```go version```
- Clone the repository somewhere: ```git clone https://git.scc.kit.edu/feudal/feudalClient.git```
- Switch to the cloned directory and run ```make build``` (or ```make build-static``` for a statically linked build)
Setup
----
Copy the binary and a config file to the target VM.
See example-config for an example configuration.
- Inspect the client version: ```feudalClient --version```
- Additional info: ```feudalClient --help```
-
- Create a configuration file using json or yaml, see [examples](./example-config).
- Inspect the client:```feudalClient --version``` and ```feudalClient --help```
- Create a configuration file using yaml (preferred) or json format, see [examples](./example-config).
- The client needs to be registerred using username and password at a [feudalBackend](https://git.scc.kit.edu/feudal/feudalBackend).
- Put the configuration into ```/etc/feudal``` or ```$HOME/.config/feudal```.
-
- Run the client: ```feudalClient```
- To use a specific config run: ```feudalClient --config <config>```
- To use a specific config use: ```feudalClient --config <config>```
Provide a service
-----
The feudalClient executes custom adapters to deploy / remove users from your service.
You'll probably need to write your own script. See [feudalScripts](https://git.scc.kit.edu/feudal/feudalScripts) for instructions and examples how to dothat.
The feudalClient executes custom scripts to deploy / remove users from your service.
You'll probably need to write your own script. See [feudalScripts](https://git.scc.kit.edu/feudal/feudalScripts) for instructions and examples how to do that.
After writing your script, hook it up into your client configuration and restart your client. This will automatically register your service(s) at the feudal backend.
......@@ -43,4 +35,4 @@ Stop providing a service
In case you want to stop providing a service follow these steps:
- Make sure that no user is still deployed and _no_ feudal user data remains at your service
- Execute the client once using: ```feudalClient deregister```
- This will remove all your services from the backend, so they won't be shown to users anymore.
- This will remove all your services from the backend, so they won't be shown to users anymore
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment