Skip to content

Commit a2ad8a0

Browse files
committed
Added link to Chef admins edit, admonition section.
1 parent 4e79646 commit a2ad8a0

1 file changed

Lines changed: 21 additions & 15 deletions

File tree

docs/operations/provision-controller.rst

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Automatic Provisioning
1414
The community maintains shell scripts that automate the provisioning
1515
of Deis controllers on different cloud providers.
1616
In addition to launching the controller itself, these scripts also
17-
use optimized base images,
18-
generate SSH keys, firewall configs and other cloud infrastructure
17+
use optimized base images,
18+
generate SSH keys, firewall configs and other cloud infrastructure
1919
per Deis best practices.
2020

2121
You can find instructions on automatic provisioning for:
@@ -29,16 +29,16 @@ Please note that even with automatic provisioning, you will still have to
2929

3030
Manual Provisioning
3131
-------------------
32-
If you want your controller on bare metal, a different cloud provider,
33-
or would just rather provision things manually --no problem!
32+
If you want your controller on bare metal, a different cloud provider,
33+
or would just rather provision things manually --no problem!
3434
Just remember with manual provisioning, you are in charge of:
3535

3636
* Ensuring system requirements are met
3737
* SSH key generation and distribution
3838
* Network configuration
3939

4040
.. important:: System Requirements
41-
Most controllers require at least 2GB of system memory and 100GB of storage
41+
Most controllers require at least 2GB of system memory and 100GB of storage
4242

4343
The general process for manual provisioning involves:
4444

@@ -76,40 +76,46 @@ you must add "deis-controller" to the "admins" group on the Chef Server.
7676

7777
Hosted Chef
7878
~~~~~~~~~~~
79-
Users using Hosted Chef can perform these `steps` to add deis-controller to admin group.
79+
For Hosted Chef, visit the `OpsCode management interface`_ to add
80+
"deis-controller" to the "admins" group. These `steps`_ describe specifically
81+
how to add users to groups in the management interface.
8082

8183
Open Source Chef
8284
~~~~~~~~~~~~~~~~
8385

84-
For opensource chef one can use knife cli tool. First, set the EDITOR environment variable to your favourite text editor.
86+
For Open Source Chef, use the knife cli tool. First, set the EDITOR environment
87+
variable to your favourite text editor:
8588

8689
``$ export EDITOR=vim``
8790

88-
Now issue the command to edit ``deis-controller`` user.
91+
Now issue the command to edit the "deis-controller" user.
8992

9093
``$ knife client edit deis-controller``
9194

9295
and update the 'admin' key to 'true'. The updated content should look similar to this.
9396

94-
.. code-block:: console
97+
.. code-block:: json
9598
96-
{
99+
{
97100
"name": "deis-controller",
98-
"public_key": "-----BEGIN PUBLIC KEY-----\nMaaBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwzKA3YNTw0qD8hcPiJpT\naYSpJI0sQF4u6/WpE4HAlGRHpjpoG/QwtuA4sosW+ebNXDbxKhDoQxsHnz97jDuZ\n4nvnTdaJRGygXABEkuUG68cV7asdGzn76bRT3GNa4LD+ekqJON7nCA/K8V3AZ1P4\nWfnPc/RfmK3InQC92w1xsX2hpZ/qzeL3Y+jxaJ7SnGgm9Q5O7PnDObNW4exzo6936\nkZFCdmQIdVfy4sGASc8ep6NW8ZHuej8vcCdFKJut9QV3S8kDl1XF2sG2DV4qMbC/\nalFRnZUy0TckSgm3fiqfi89u2bbSlfzrTHv2NU9xaYDv7QQpFoZ62PKG9SdJ9R5G\nUwIDAQAB\n-----END PUBLIC KEY-----\n",
101+
"public_key": "-----BEGIN PUBLIC KEY-----\nMaa...QAB\n-----END PUBLIC KEY-----\n",
99102
"admin": true,
100103
"json_class": "Chef::ApiClient",
101104
"chef_type": "client"
102-
}
105+
}
103106
104-
Save and close the file. The user is now in admin group.
107+
Save and close the file. The "deis-controller" user is now in the "admins" group.
105108

106-
If you skip this step, you will receive errors when scaling down nodes as the
107-
controller will not have permissions to delete "client" and "node" records from the Chef Server.
109+
.. important::
110+
If you skip adding "deis-controller" to the Chef "admins" group, you will
111+
receive errors when scaling down nodes, as the controller will not have
112+
permission to delete "client" and "node" records from the Chef Server.
108113

109114
.. _`EC2`: https://github.com/opdemand/deis/tree/master/contrib/ec2#readme
110115
.. _`Rackspace`: https://github.com/opdemand/deis/tree/master/contrib/rackspace#readme
111116
.. _`Digital Ocean`: https://github.com/opdemand/deis/tree/master/contrib/digitalocean#readme
112117
.. _`add the controller to the admins group`: #add-controller-to-admins-group
113118
.. _`knife`: http://docs.opscode.com/knife.html
119+
.. _`OpsCode management interface`: https://manage.opscode.com/groups/admins/edit
114120
.. _`steps`: http://docs.opscode.com/manage_server_hosted_groups.html#add-user-to-group
115121

0 commit comments

Comments
 (0)