Skip to content

Commit b0cf172

Browse files
added table of contents
1 parent 7403fba commit b0cf172

File tree

2 files changed

+37
-29
lines changed

2 files changed

+37
-29
lines changed

INSTALL.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Installation
2+
3+
This plugin gets installed through ```bitops.config.yaml``` in the bitops core level. This file is located [here](https://github.com/bitovi/bitops/blob/plugins/bitops.config.yaml)
4+
5+
6+
### Sample Config
7+
8+
```
9+
bitops:
10+
fail_fast: true
11+
run_mode: default
12+
logging:
13+
level: DEBUG
14+
color:
15+
enabled: true
16+
filename: bitops-run
17+
err: bitops.logs
18+
path: /var/logs/bitops
19+
opsrepo_root_default_dir: _default
20+
plugins:
21+
aws:
22+
source: https://github.com/bitops-plugins/aws
23+
...
24+
...
25+
...
26+
27+
```
28+
29+
## Installed Libraries
30+
``awscliv2`` and ``aws-iam-authenticator`` libraries gets installed as part of aws plugin installation of BitOps

README.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,16 @@
11
# Bitops Plugin for AWS
22

3-
## Introduction
4-
This is one of the required plugins that sets credentials for AWS to run deployments using BitOps.
5-
3+
## Table of contents
64

7-
## Installation
5+
1. [Introduction](#Introduction)
6+
2. [Installation](https://github.com/bitops-plugins/aws/blob/main/INSTALL.md)
7+
3. [Deployment](#Deployment)
88

9-
This plugin gets installed through ```bitops.config.yaml```.
9+
---
1010

11-
### Sample Config
12-
13-
```
14-
bitops:
15-
fail_fast: true
16-
run_mode: default
17-
logging:
18-
level: DEBUG
19-
color:
20-
enabled: true
21-
filename: bitops-run
22-
err: bitops.logs
23-
path: /var/logs/bitops
24-
opsrepo_root_default_dir: _default
25-
plugins:
26-
aws:
27-
source: https://github.com/bitops-plugins/aws
28-
...
29-
...
30-
...
31-
32-
```
11+
## Introduction
12+
This is one of the required plugins that sets credentials for AWS to run deployments using BitOps.
3313

34-
## Installed Libraries
35-
``awscliv2`` and ``aws-iam-authenticator`` libraries gets installed as part of aws plugin installation of BitOps
3614

3715
## Deployment
3816

0 commit comments

Comments
 (0)