Skip to content

Commit

Permalink
Chef Infra Server WebUI Key (#6841)
Browse files Browse the repository at this point in the history
* added the section for WebUI in chef infra server

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* removed the add organization section from the page

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* fixed some minor issues in the page

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* added the section for WebUI in chef infra server

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* removed the add organization section from the page

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* fixed some minor issues in the page

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* updates the doc with webui section

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* added images for the update webui key section

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* bug fixes

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* changes made to the webUI section

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* updated the chef server information section

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* Update components/docs-chef-io/content/automate/chef_infra_server.md

Co-authored-by: Kallol Roy <karoy@progress.com>

* Update components/docs-chef-io/content/automate/chef_infra_server.md

Co-authored-by: Kallol Roy <karoy@progress.com>

* review changes

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

* changes updated

Signed-off-by: Dishank Tiwari <dtiwari@progress.com>

Co-authored-by: Kallol Roy <karoy@progress.com>
  • Loading branch information
2 people authored and vinay033 committed Apr 13, 2022
1 parent 7a12aba commit 88ad06c
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 12 deletions.
56 changes: 44 additions & 12 deletions components/docs-chef-io/content/automate/chef_infra_server.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "Chef Infra Server"

weight = 20
draft = false

gh_repo = "automate"
Expand Down Expand Up @@ -36,35 +35,68 @@ The objects that you can manage from the Chef Infra Server are:
- Policyfiles
- PolicyGroup

## Chef Automate WebUI Key

Chef Automate uses the Web UI private key for signing requests sent to the Chef Infra Server. The key is subject to Chef server’s Secrets Management, and will be stored in `/etc/opscode/private-chef-secrets.json`.

Any run of `chef-server-ctl` reconfigure will ensure the key exists and is stored without any additional steps.

To verify that the key is stored and ready to use by manage, run:

```cmd
chef-server-ctl show-secret chef-server webui_key
-----BEGIN RSA PRIVATE KEY-----
MIIEpgIBAAKCAQEA3fJ+U+5prsJ8PtnbYzWAq+J2cE48u+iT7t/M9JS+3tlEgf3r
1PTl70cW9jOI+kGGvayTKb8Dzqtm0tpQJo7Bv+XX42OylyVF2SN4WvMusT+jtJuF
...
-----END RSA PRIVATE KEY-----
```

## Connect Chef Infra Servers to Chef Automate

The _Chef Infra Server_ panel starts with an empty list of servers.

To add existing Chef Infra Servers to the Chef Automate infrastructure, select **Add Chef Server**, which will request the name, FQDN, and IP address of your Chef Infra Server:
To add existing Chef Infra Servers to the Chef Automate infrastructure, select **Add Chef Server**, which will request the name, FQDN or IP address, and WebUI key of your Chef Infra Server:

{{< figure src="/images/automate/add-chef-server-popup-menu.png" width="500" alt="Add Chef Server Form">}}

Chef Automate warns you if you enter an invalid FQDN or IP address:
{{< note >}} The above feature is only available for Automate admin. {{< /note >}}

Chef Automate warns you if you enter an invalid name, FQDN, IP address or WebUI key:

{{< figure src="/images/automate/add-chef-server-popup-menu-with-error.png" width="500" alt="Add Chef Server Form">}}

Once done, select **Add Chef Server** and see the server in the list of Chef Infra Servers.

## Connect a Chef Organization to a Chef Infra Server
### Chef Server Information

In Chef Infra Server, you can view the details of the infra servers created. Select the created infra server, and the UI shows the information of the infra server.

{{< figure src="/images/automate/chef-server-details-page.png" alt="Chef Infra Server Information Page">}}

In the above image you can view:

1. The **FQDN** you inserted while creating.
1. The **IP** address.
1. The **WebUI** key.
1. Last Sync Date.
1. Last Migration Status.

You can also update the **WebUI** key by selecting the *Update* option of the WebUI key.

### Update WebUI Key

To view a list of existing [organizations]({{< relref "server_orgs" >}}) on a Chef Infra Server,
select a Chef Infra Server from the **Chef Servers** list, then select the **Organizations** tab, as shown below:
In case you have mentioned an incorrect WebUI key, you can update the same by following the steps:

{{< figure src="/images/automate/chef-server-organization.png" alt="Chef Infra Server Organization">}}
* Select **Update** in front of the WebUI key as shown below:

To create a new organization, see the documentation on [setting up a Chef Infra Server]({{< relref "infra_server#set-up-the-chef-infra-server" >}}).
{{< figure src="/images/automate/chef-infra-server-update-webui-key-main-page.png" alt="Select Update for WebUI Key">}}

To add an existing organization, select **Add Chef Organization**, which opens a dialog box as shown below:
* Update the correct WebUI key in the text box shown below:

{{< figure src="/images/automate/add-chef-organization-popup-menu.png" width="500" alt="Add Chef Organization Form">}}
{{< figure src="/images/automate/chef-infra-server-update-webui-key.png" alt="Select Update for WebUI Key">}}

Enter the _Name_, _Projects_, _Admin User_, and _Admin Key_ fields using the same values provided when the organization gets configured using _Knife_.
Copy the contents of the `~/.chef/USER.pem` file and paste it into the **Admin Key** field. Then select **Add Chef Organization** to add the organization to the Chef Infra Server.
Follow the above two steps to update the WebUI key of the Chef Automate.

## Access Chef Infra Server Components

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 88ad06c

Please sign in to comment.