ungleich-cli/README.md

103 lines
1.6 KiB
Markdown
Raw Normal View History

2019-05-12 10:31:51 +00:00
# ungleich cli
2019-04-27 04:56:57 +00:00
2019-05-12 10:31:51 +00:00
This CLI is used for day-to-day tasks used at ungleich.
It is intended to be used by ungleich engineers and skilled customers.
2019-04-27 04:56:57 +00:00
2019-05-12 10:31:51 +00:00
## Requirements / Installation
2019-06-07 11:37:42 +00:00
* ensure you have **python3** and **pipenv**
2019-05-12 10:31:51 +00:00
* git clone this repo
2019-06-06 10:37:39 +00:00
* cd into this repo
* run the following command
```
2019-06-07 11:37:42 +00:00
pipenv install
pipenv shell
2019-06-06 10:37:39 +00:00
```
2019-05-12 10:42:28 +00:00
## Usage general
2019-04-27 04:56:57 +00:00
```
2019-05-12 10:42:28 +00:00
ungleich --help
```
2019-06-06 10:37:39 +00:00
## Usage: Weather
```
ungleich weather
```
2019-04-27 04:56:57 +00:00
2019-06-12 01:11:27 +00:00
## Usage: Config
```
ungleich config-add \
--name <otp username>
--realm <otp realm>
--seed <otp seed>
```
2019-05-12 10:42:28 +00:00
## Usage: DNS
```
2019-06-12 01:11:27 +00:00
ungleich dns \
--set-reverse <ip>
--user <user_id>
--email <email>
--name mirror.example.com
2019-05-12 09:25:50 +00:00
```
### Usage: RIPE
Creating a new route6 object:
```
2019-05-12 10:42:28 +00:00
ungleich ripe-add-route6 \
2019-05-12 09:25:50 +00:00
--network 2a09:2947::/32
--description "First REST /32"
--password "very secure"
```
2019-05-30 09:26:12 +00:00
### Usage: Account
Creating a new account object:
```
2019-06-12 01:11:27 +00:00
ungleich account \
--create-user <username>
--name <firstname>
--lastname <lastname>
--email <email>
2019-05-30 09:26:12 +00:00
```
2019-06-08 17:18:37 +00:00
### Usage: SSH Key
2019-06-08 17:29:03 +00:00
Requires you to have
https://code.ungleich.ch/ungleich-public/ungleich-ssh-keys/ checked
out in ~/vcs/ungleich-ssh-keys
2019-06-08 17:18:37 +00:00
```
ungleich sshkey --key raul.ascencio --host dev.raul.ungleich.cloud
```
### Usage: VPN Management
Creating a new VPN:
```
ungleich vpn-create \
--server_url <server_url>
--name <name>
--realm <realm>
--seed <seed_value>
--email <email>
--public_key <public_key>
```
Deleting a VPN:
```
ungleich vpn-delete \
--server_url <server_url>
--name <name>
--realm <realm>
--seed <seed_value>
```