Skip to content

Commit 9fe5f71

Browse files
costimuraruConstantin Muraru
authored andcommitted
[DOC] Update README.md
1 parent bd9dc3e commit 9fe5f71

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,15 @@
33
## Ops CLI
44

55
**ops-cli** is a python wrapper for [Terraform](https://www.terraform.io/), [Ansible](https://www.ansible.com/) and SSH for cloud automation.
6-
It also integrates with the AWS cli, in order to provide inventory, ssh, sync, tunnel and the possibility to run ansible playbooks on top of EC2 instances.
7-
It can be used to add a layer of templating (using jinja2) on top of Terraform files. This is useful for removing duplicated code when it comes to spinning up infrastructure across multiple environments (stage/sandbox/prod) and across teams. Useful for both AWS and Kubernetes deployments, given that Terraform has support for Amazon Elastic Kubernetes (EKS).
6+
7+
We use multiple tools to manage our infrastructure at Adobe. The purpose of `ops-cli` is to gather the common cluster configurations in a single place and, based on these, interact with the above mentioned tools. In this way, we can avoid duplication and can quickly spin up new clusters (either production or development ones). All we need to do is customize the cluster configuration file ([example here](https://github.com/adobe/ops-cli/blob/master/examples/aws-kubernetes/clusters/my-kubernetes-cluster.yaml)).
8+
9+
`ops-cli` integrates with the Azure and AWS cli, in order to provide inventory, ssh, sync, tunnel and the possibility to run ansible playbooks on a fleet of EC2 instances.
10+
It can be used to add a layer of templating (using jinja2) on top of Terraform files. This is useful for removing duplicated code when it comes to spinning up infrastructure across multiple environments (stage/sandbox/prod) and across teams. Useful for both AWS and [Kubernetes deployments](https://github.com/adobe/ops-cli/tree/master/examples/aws-kubernetes).
811

912
## How it works?
1013

11-
You define a cluster configuration, using a yaml file. The yaml file can contain different kind of sections. For instance, you could have a section for terraform files, a section for AWS instructions and so forth.
14+
You define a cluster configuration, using a yaml file. The yaml file contains different kind of sections, one for each plugin. For instance, you could have a section for Terraform files, a section for AWS instructions, Kubernetes Helm charts and so forth.
1215

1316
## Use cases
1417

@@ -80,8 +83,8 @@ pip2 install -U virtualenv
8083
virtualenv ops
8184
source ops/bin/activate
8285

83-
# install opswrapper v0.22 stable release
84-
pip2 install --upgrade https://github.com/adobe/ops-cli/releases/download/0.22/ops-0.22.tar.gz
86+
# install opswrapper v0.23 stable release
87+
pip2 install --upgrade https://github.com/adobe/ops-cli/releases/download/0.23/ops-0.23.tar.gz
8588

8689
# Optionally, install terraform to be able to access terraform plugin
8790
# See https://www.terraform.io/intro/getting-started/install.html

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
_requires = [ r for r in open(os.path.sep.join((_mydir,'requirements.txt')), "r").read().split('\n') if len(r)>1 ]
1717
setup(
1818
name='ops',
19-
version='0.22',
19+
version='0.23',
2020
description='Ops simple wrapper',
2121
author='Adobe',
2222
author_email='[email protected]',

0 commit comments

Comments
 (0)