Skip to content

Commit 1f12238

Browse files
committed
Updating README
1 parent 33cab9f commit 1f12238

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

README.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1-
Unified VM-Instance Management Utility across AWS, Azure and GCP Platforms
1+
Unified Instance Management Utility across AWS, Azure and GCP Platforms
22
==========================================================================
33

44
MCC: Command-Line Instance Control for Enterprise Cloud Providers
55
-----------------------------------------------------------------
66

77
|PyPi release| |lang|
8-
9-
----------------------------
8+
---------------------
109

1110
Multi-Cloud-Control provides a single solution for controlling cloud VMs/Instances on AWS, Azure and GCP (including multiple accounts per provider). This includes displaying a unified list of VM-instances across cloud providers, and Starting / Stopping / Connecting to VM-instances on any providers platforms. This is extremely useful for companies, projects, and people that use VM-instances on multiple clouds.
1211

13-
There are two commands that can be used depending on the needs at the time: ``mccl`` - "List Mode" and ``mcc`` - "Command Mode". Each command is described below and screenshots of each are provided.
12+
There are two commands that can be used depending on the needs at the time: ``mccl`` - "List Mode" and ``mcc`` - "Command Mode". Each command is described below and screenshots of each are provided.
1413

1514
``mccl``
1615
--------
1716

1817
- ``mccl`` displays list of VM-instances and data from all providers (and returns to the prompt)
1918

20-
- useful to quickly display a list of VM-instances - including name, location, cloud provider, machine-size, IP address and opperational-status
19+
- useful to quickly display a list of VM-instances - including name, location, cloud provider, machine-size, IP address and operational-status
2120

2221

2322
**List Mode screenshot**
@@ -26,7 +25,7 @@ There are two commands that can be used depending on the needs at the time: ``mc
2625
.. image:: https://user-images.githubusercontent.com/1554603/33449863-4b1e182a-d5c7-11e7-958e-a1fac2ec1ee5.png
2726

2827

29-
``mcc``
28+
``mcc``
3029
-------
3130

3231
- ``mcc`` displays a numbered list of VM-instances and data from all providers and awaits a command
@@ -56,7 +55,7 @@ Platforms:
5655
Pre-Reqs
5756
--------
5857

59-
The libraries used for secure authentication may require compilation during the installation process on some systems. In order to sucessfully compile these dependancies, the following packages must be installed before installation:
58+
The libraries used for secure authentication may require compilation during the installation process on some systems. In order to successfully compile these dependencies, the following packages must be installed before installation:
6059

6160
**Installing Pre-Reqs on Debian / Ubuntu Based Systems:**
6261

@@ -100,7 +99,7 @@ Notes while editing the config.ini file:
10099
**config.ini - info section and providers list**
101100

102101

103-
.. code::
102+
.. code:: ini
104103
105104
# 'INFO' SECTION AND 'PROVIDERS' LIST
106105
# - There must be a section named [info] and it must contain the entry providers
@@ -124,7 +123,7 @@ Notes while editing the config.ini file:
124123
**[aws] section** - specifies your AWS security credentials and default datacenter region. `Information on AWS Credentials <http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html>`_
125124

126125

127-
.. code::
126+
.. code:: ini
128127
129128
# [aws] SECTION REQUIRED if aws is listed in providers
130129
@@ -137,7 +136,7 @@ Notes while editing the config.ini file:
137136
**[azure] section** - specifies your Azure Tenant-ID, Subscription-ID, Application-ID and Application-Secret. `Creating an Azure Service Principal <https://azure.microsoft.com/en-us/documentation/articles/resource-group-authenticate-service-principal>`_
138137

139138

140-
.. code::
139+
.. code:: ini
141140
142141
# [azure] SECTION REQUIRED if azure is listed in providers
143142
@@ -151,7 +150,7 @@ Notes while editing the config.ini file:
151150
**[gcp] section** - supports two authentication types. Service Account is likely easier for many users, but both options are available. Specify the type of Authentication: (S)ervice or (A)pplication (defaults to service if not specified), Google Compute project-id, and the remaining variables required for the authentication type as described below. `Information on Setting up Service Account Authentication <https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances>`_
152151

153152

154-
.. code::
153+
.. code:: ini
155154
156155
# [gcp] SECTION REQUIRED if gcp is listed in providers
157156
@@ -189,7 +188,7 @@ Notes while editing the config.ini file:
189188
**specifying multiple accounts** - for one or more providers
190189

191190

192-
.. code::
191+
.. code:: ini
193192
194193
# Step 1
195194
# - add an additional entry to the 'providers' list - in this exact format:

0 commit comments

Comments
 (0)