Skip to content

Commit af481f7

Browse files
author
Lucio Delelis
committed
documents new variables
1 parent 4c2c97f commit af481f7

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
ansible-ovhbastion
22
=========
3-
[![Build Status](https://travis-ci.com/adamsbytes/ansible-ovhbastion.svg?branch=main)](https://travis-ci.com/adamsbytes/ansible-ovhbastion)
4-
53
This role installs and configures [OVH Cloud](https://www.ovh.com/world/)'s [the Bastion](https://github.com/ovh/the-bastion) secured jump host server. The ovhbastion role is based on the [official Bastion installation instructions](https://ovh.github.io/the-bastion/installation/basic.html). Please visit [the official Bastion documentation](https://ovh.github.io/the-bastion/index.html) for more information.
64

75
Once you run this role, [click here](https://ovh.github.io/the-bastion/using/basics.html) to view the next steps in configuring the Bastion.
@@ -11,6 +9,7 @@ Tested On
119

1210
- Debian 8+
1311
- Ubuntu 18+
12+
- CentOS 8
1413

1514
Role Variables
1615
--------------
@@ -21,10 +20,29 @@ Role Variables
2120
#### Recommended
2221
`bastion_name`: string with name of bastion host. the system's actual hostname is _not_ recommended\
2322
`bastion_create_admin`: toggle creation of the superadmin account\
24-
`bastion_superadmin_uname`: string with username for the bastion superadmin (if enabled)
23+
`bastion_superadmin_uname`: string with username for the bastion superadmin (if enabled)\
24+
`bastion_initial_users`: list of users to create after bastion setup\
25+
`bastion_initial_groups`: list of groups to create after bastion setup
2526

2627
See `defaults/main.yml` for optional variables that can be set.
2728

29+
#### User detail
30+
31+
|attribute|type|description|required|
32+
|---|---|---|---|
33+
|name|string|name of the user to create|true|
34+
|public_key|string|SSH ingress key for the bastion user. The key must be generated as either: <br/><ul><li>ed25519</li><li>ecdsa</li><li>rsa 4096 bits</li></ul>|true|
35+
|hosts|list(string)|List of DNS records/IP addresses to grant initial access to|false|
36+
|groups|list(string)|List of groups the new user should belong to (currently disabled)|false|
37+
38+
#### Group detail
39+
40+
|attribute|type|description|required|
41+
|---|---|---|---|
42+
|name|string|Group name|true|
43+
|owner|string|Username of the group owner|true|
44+
|hosts|list(string)|List of DNS records/IP addresses to grant initial access to|false|
45+
2846
Role Installation
2947
------------
3048

0 commit comments

Comments
 (0)