Skip to content

Commit 9fc88fc

Browse files
chandanapatnalachandanapatnala
authored
#AV-169938: Adding readme to avise role (#147)
* Adding readme to avise role * Added a new line at the end of avi_api.py file
1 parent 5a42bf9 commit 9fc88fc

File tree

3 files changed

+153
-1
lines changed

3 files changed

+153
-1
lines changed

‎plugins/module_utils/avi_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1104,4 +1104,4 @@ def delete_session(self):
11041104
logger.debug("Removed session for : %s", self.key)
11051105
sessionDict.pop(self.key, None)
11061106
return
1107-
# End of file
1107+
# End of file

‎roles/avise/README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# vmware.alb.avise
2+
3+
Using this module you are able to install the Avi Vantage Service Engine, to your system. However, minimum requirements must be met. Please visit the Avi SE Requirements webpage: https://kb.avinetworks.com/docs/latest/system-requirements-hardware/
4+
5+
## Requirements
6+
7+
- Docker is required, and can be installed using `avinetworks.docker` or manually installed.
8+
9+
- `avisdk` python library is required and can be installed by:
10+
`pip install avisdk --upgrade`
11+
12+
## Role Dependencies
13+
14+
- avinetworks.avisdk
15+
- To install these use the following command: `ansible-galaxy install -f avinetworks.avisdk`
16+
17+
## Role Variables
18+
19+
### Standard Parameters
20+
| Variable | Required | Default | Comments |
21+
|----------|----------|---------|----------|
22+
| `se_skip_requirements` | No | `false` | Skips any requirements for disk space, ram, and cpu. |
23+
24+
### Auto-registration parameters
25+
| Variable | Required | Default | Comments |
26+
|----------|----------|---------|----------|
27+
| `se_autoregister` | No | `true` | Autoregister the service engine to the specified controller. |
28+
| `se_auth_token` | No | `None`| If defined it will be the token used to register the service engine to the controller |
29+
| `se_master_ctl_ip` | No | `None` | The IP address of the controller. |
30+
| `se_master_ctl_username` | No | `None` | The username to login into controller api. <br>**Not required when `se_autoregister: false`** |
31+
| `se_master_ctl_password` | No | `None` | The passowrd to login into the controller api. <br>**Not required when `se_autoregister: false`** |
32+
| `se_cloud_name` | No | `Default-Cloud` | Name of cloud the SE should auto-register with. |
33+
| `se_tenant` | No | `admin` | Name of se_tenant the SE should auto-register with. |
34+
| `segroup_uuid` | No | `None` | Uuid of segroup_uuid the SE should auto-register with. |
35+
36+
### Package Deploy Variables
37+
| Variable | Required | Default | Comments |
38+
|----------|----------|---------|----------|
39+
| `se_package_deploy` | No | `false` | Set to true to deploy via package. |
40+
| `se_package_source` | No | `se_docker.tgz` | Source location of the docker tgz |
41+
| `se_package_dest` | No | `/tmp/se_docker.tgz` | Destination location on the remote server |
42+
43+
### Docker Hub and Docker Repo Variables
44+
| Variable | Required | Default | Comments |
45+
|----------|----------|---------|----------|
46+
| `se_docker_repo` | No | `None` | If using a local repository please enter it here. |
47+
| `se_version` | No | `latest` | Version of the Avi Service Engine package you want to deploy. |
48+
| `se_image` | No | `avinetworks/se:{{ se_version }}` | Full name of the service engine image. |
49+
| `se_docker_repo_user` | No | `None` | User to be used for repository authentication. |
50+
| `se_docker_repo_password` | No | `None` | Password to be used for repository authentication. |
51+
52+
### Docker Deployment Variables
53+
| Variable | Required | Default | Comments |
54+
|-----------------------|----------|-----------|---------|
55+
| `se_dpdk` | No | `false` | When set to true performs se_dpdk installation. |
56+
| `se_inband_mgmt` | No | `false` | Enables inband management interface for this Service Engine (i.e. Use Management interface for data traffic as well). |
57+
| `se_cores` | No | `{{ ansible_processor_cores * ansible_processor_count }}` | How many cores the service engine will use. |
58+
| `se_memory_gb` | No | `{{ ansible_memtotal_mb / 1024 }}` | How much memory the service engine will use. |
59+
| `se_destination_disk` | No | auto-detect based on `ansible_mounts` largest sized disk | The disk that the service engine data will be installed |
60+
| `se_disk_path` | No | `{{ se_destination_disk }}opt/avi/se/data` | The path that the service engine data will be installed. |
61+
| `se_disk_gb` | No | `10` | The size of the disk that will be used by service engine data. |
62+
| `se_logs_disk_path` | No | `None` | The path that the service engine log data will be stored. |
63+
| `se_logs_disk_gb` | No | `None` | The size of the disk that will be used by log data. |
64+
| `se_fresh_install` | No | `false` | Erases any pre-existing directories associated with the service engine. |
65+
| `se_mounts_extras` | No | `[]` | Extra mounting points to be used by the service engine. <br>No need to include the `-v` |
66+
| `se_env_variables_extras` | No | `[]` | Extra environment variables to be used by the service engine. <br>No need to include `-e` |
67+
68+
## Example Playbooks
69+
70+
**WARNING:**
71+
**Before using this example please make the correct changes required for your server. For more information please visit [https://kb.avinetworks.com/sizing-service-engines/] (https://kb.avinetworks.com/sizing-service-engines/)**
72+
73+
**It is recommended you adjust these parameters based on the implementation desired.**
74+
### Standard Example
75+
```
76+
77+
- hosts: service_engines
78+
collections:
79+
- vmware.alb
80+
tasks:
81+
- name: Create a dockersied se
82+
include_role:
83+
name: avise
84+
vars:
85+
se_master_ctl_ip: 10.10.27.101
86+
se_master_ctl_username: admin
87+
se_master_ctl_password: avi123
88+
se_disk_gb: 60
89+
se_cores: 4
90+
se_memory_gb: 12
91+
```
92+
93+
### Minimum Example
94+
```
95+
96+
- hosts: service_engines
97+
collections:
98+
- vmware.alb
99+
tasks:
100+
- name: Create a dockersied se
101+
include_role:
102+
name: avise
103+
vars:
104+
se_master_ctl_ip: 10.10.27.101
105+
se_master_ctl_username: admin
106+
se_master_ctl_password: avi123
107+
```
108+
109+
### Example without Auto-registration
110+
```
111+
112+
- hosts: all
113+
collections:
114+
- vmware.alb
115+
tasks:
116+
- name: Create a dockersied se
117+
include_role:
118+
name: avise
119+
vars:
120+
se_master_ctl_ip: 10.10.27.101
121+
se_auth_token: "{{ se_auth_token }}"
122+
```
123+

‎roles/avise/README_ADVANCED.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# avinetworks.avise
2+
3+
This readme covers the advanced features of this role. These notes are for advanced users or customizing this role to use in unique environments including Development environments. Please use the following with extreme caution.
4+
5+
## Role Variables
6+
7+
### Parameter Override Variables
8+
However, you are able to provide these parameters another way. Using the following variables. This will allow the user to customize all values.
9+
**!!!BEWARE: USING THIS WILL ERASE DEFAULTS - USE WITH CAUTION!!!**
10+
11+
```
12+
13+
se_env_variables_all:
14+
- "CONTAINER_NAME=avise"
15+
- "CONTROLLERIP=10.10.27.101""
16+
- "NTHREADS=4"
17+
- "SEMEMMB=4096"
18+
- "DOCKERNETWORKMODE=HOST"
19+
20+
se_mounts_all:
21+
- "/mnt:/mnt"
22+
- "/dev:/dev"
23+
- "/etc/sysconfig/network-scripts:/etc/sysconfig/network-scripts"
24+
- "/:/hostroot/"
25+
- "/etc/hostname:/etc/host_hostname"
26+
- "/etc/localtime:/etc/localtime"
27+
- "/var/run/docker.sock:/var/run/docker.sock"
28+
- "/opt/avi/se/data:/vol/"
29+
```

0 commit comments

Comments
 (0)