Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
knelasevero committed Jan 5, 2022
1 parent 94d8585 commit 8ddcbd5
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ cp pkg/configdata/ss.yml.example pkg/configdata/ss.yml
Open `pkg/configdata/es.yml` and edit the following fields:

- **spec.refreshInterval:** Choose a Time Duration interval used by the operator to fetch new secrets (1m = 1 minute, 1h = 1 hour, etc).
- **spec.target.name:** #TODO: chose the env file where this will end up? (for now writing to /etc/environment - you need to run as root to write to this file)
- **spec.target.name:** Chose the env file where this will end up (default is /etc/environment - You need to run as root to write there).
- **spec.data.secretKey:** The name of the Env Var injected in the machine.
- **spec.data.remoteRef.Key:** The name of the secret in the external provider.

Expand Down Expand Up @@ -61,6 +61,12 @@ tar -xvf vmes_${VMES_VERSION}_linux_amd64.tar.gz
sudo cp vmes /usr/local/bin/
```

To run the installed release just call vmes anywhere:

```
vmes
```

If you want you can build the executable locally:

```
Expand All @@ -73,6 +79,33 @@ And run it:
./vmes
```

## Systemd config

You probably want to to run this tool as a service in a machine. For that you can create a Systemd unit file and let Systemd manage it. Run these commands:

```
sudo cat > /etc/systemd/system/vmes.service <<EOF
[Unit]
Description=vmes
After=network.target
[Service]
Type=idle
User=root
Group=keycloak
ExecStart=vmes
TimeoutStartSec=600
TimeoutStopSec=600
[Install]
WantedBy=multi-user.target
EOF
sudo systemctl daemon-reload
sudo systemctl start vmes
sudo systemctl enable vmes
```

## Roadmap

- [] Only AWS provider working for now, need to reimplement schema here or have another way to grab the right provider
Expand Down

0 comments on commit 8ddcbd5

Please sign in to comment.