Skip to content

Commit 3f85cc9

Browse files
committed
[RELEASE] - Release version 0.30 ADDENDUM
1 parent 350b6a9 commit 3f85cc9

File tree

1 file changed

+51
-21
lines changed

1 file changed

+51
-21
lines changed

README.md

Lines changed: 51 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,52 @@
11
[![Build Status](https://www.travis-ci.com/adobe/ops-cli.svg?token=8uHqfhgsxdvJ93qWAxhn&branch=master)](https://www.travis-ci.com/adobe/ops-cli)
22

3+
<!--ts-->
4+
5+
* [Ops CLI](#ops-cli)
6+
* [How it works?](#how-it-works)
7+
* [Use cases](#use-cases)
8+
* [Manage AWS EC2 instances](#manage-aws-ec2-instances)
9+
* [Terraform](#terraform)
10+
* [Create Kubernetes cluster (using AWS EKS)](#create-kubernetes-cluster-using-aws-eks)
11+
* [Installing](#installing)
12+
* [Local](#local)
13+
* [Virtualenv](#virtualenv)
14+
* [Ops tool installation](#ops-tool-installation)
15+
* [Using docker image](#using-docker-image)
16+
* [Development mode](#development-mode)
17+
* [Configuring](#configuring)
18+
* [AWS](#aws)
19+
* [Azure](#azure)
20+
* [Examples](#examples)
21+
* [Usage help](#usage-help)
22+
* [More help](#more-help)
23+
* [Tool configuration: .opsconfig.yaml](#tool-configuration-opsconfigyaml)
24+
* [Inventory](#inventory)
25+
* [AWS example](#aws-example)
26+
* [Azure example](#azure-example)
27+
* [Inventory usage](#inventory-usage)
28+
* [Terraform](#terraform-1)
29+
* [Terraform landscape](#terraform-landscape)
30+
* [SSH](#ssh)
31+
* [SSHPass](#sshpass)
32+
* [Play](#play)
33+
* [Run command](#run-command)
34+
* [Sync files](#sync-files)
35+
* [Noop](#noop)
36+
* [Packer](#packer)
37+
* [Secrets Management](#secrets-management)
38+
* [Vault](#vault)
39+
* [Amazon Secrets Manager (SSM)](#amazon-secrets-manager-ssm)
40+
* [Using jinja2 filters in playbooks and terraform templates](#using-jinja2-filters-in-playbooks-and-terraform-templates)
41+
* [Development](#development)
42+
* [Running tests](#running-tests)
43+
* [Troubleshooting](#troubleshooting)
44+
45+
<!-- Added by: amuraru, at: Sun May 19 14:13:27 EEST 2019 -->
46+
47+
<!--te-->
48+
49+
350
# Ops CLI
451

552
**ops-cli** is a python wrapper for [Terraform](https://www.terraform.io/), [Ansible](https://www.ansible.com/) and SSH for cloud automation.
@@ -121,7 +168,7 @@ ops clusters/my-kubernetes-cluster.yaml terraform --path-name aws-eks plan
121168
# in order to setup aws-kubernetes follow the steps from https://github.com/adobe/ops-cli/blob/master/examples/aws-kubernetes/README.md
122169
```
123170

124-
#### Optional: install `ops` in development mode
171+
## Development mode
125172

126173
```
127174
git clone https://github.com/adobe/ops-cli.git
@@ -131,27 +178,18 @@ brew install openssl libyaml
131178
env LDFLAGS="-L$(brew --prefix openssl)/lib" CFLAGS="-I$(brew --prefix openssl)/include" python setup.py develop
132179
```
133180

134-
## Release (for maintainers)
135-
136-
1. Install: `pip install bump2version`
137-
2. Bump version: `bump2version minor`
138-
3. Push the release commit: `git push --follow-tags`
139-
4. Wait for Travis to build at https://www.travis-ci.com/adobe/ops-cli
140-
* This will publish a release to https://github.com/adobe/ops-cli/releases
141-
* Publish a new docker image version to https://hub.docker.com/r/adobe/ops-cli
142-
143-
144181
## Configuring
182+
145183
### AWS
146184
If you plan to use ops with AWS, you must configure credentials for each account
147185
```shell
148186
$ aws configure --profile aws_account_name
149187
```
150188

151-
## Azure
189+
### Azure
152190
TBD
153191

154-
## Examples
192+
### Examples
155193

156194
See [examples/](https://github.com/adobe/ops-cli/tree/master/examples) folder:
157195
- cassandra-stress - n-node cassandra cluster used for stress-testing; a basic stress profile is included
@@ -624,14 +662,6 @@ class FilterModule(object):
624662
# test_custom_filters: "{{ 'value' | my_filter }}"
625663
```
626664
627-
## SKMS
628-
Create a file in `~/.skms/credentials.yaml` which looks like the following:
629-
```yaml
630-
endpoint: "api.skms.mycompany.com"
631-
username: <username>
632-
password: <password>
633-
```
634-
635665
## Development
636666
637667
### Running tests

0 commit comments

Comments
 (0)