Usage reporting content (#149)

.gitignore

@@ -6,4 +6,4 @@ tech-doc-hugo
 .DS_Store
 axway-open-docs-common/
 package-lock.json
-
+.hugo_build.lock

content/en/docs/management_guide/managing_environments/_index.md

@@ -0,0 +1,11 @@
+---
+title: Managing environments
+linkTitle: Managing environments
+weight: 35
+date: 2023-09-12
+---
+
+Select **Environments** from the *Organization* left navigation menu. You can do the following with environments in the Amplify platform as an administrator:
+
+* View and edit environment information.
+* Delete environments (not applicable to environments created through Amplify Central).

content/en/docs/management_guide/managing_environments/adding_environment_ui.md

@@ -0,0 +1,13 @@
+---
+title: Adding an environment with the UI
+linkTitle: Adding an environment with the UI
+weight: 10
+date: 2023-09-12
+---
+1. Sign into the Amplify platform and select **Organization** from the *User* dropdown menu.
+2. Click **Environments** from the left navigation.
+3. Click **+ Environment** at the top right.
+4. Complete the following fields:
+    * **Name** - Provide a name for your service account. A good illustrative naming pattern could be `<product name>_<environment_type>`.
+    * **Production Flag** - Set the production flag to Yes if this is a production environment. This will affect the usage reporting is not set correctly.
+    * **Governance** - If the environment is installed in your infrastructure, select Customer Managed.

content/en/docs/management_guide/managing_environments/editing_environment_ui.md

@@ -0,0 +1,13 @@
+---
+title: Editing an environment with the UI
+linkTitle: Editing an environment with the UI
+weight: 20
+date: 2023-09-13
+---
+1. Sign into the Amplify platform and select **Organization** from the User dropdown menu.
+2. Click **Environments** from the left navigation.
+3. Select any of the existing environment definitions by clicking on the name of the environment.
+4. Edit any of the following values:
+    * **Name** - Provide a name for your service account. A good illustrative naming pattern could be `<product name>_<environment_type>`.
+    * **Production Flag** - Set the production flag to Yes if this is a production environment. This will affect the usage reporting is not set correctly.
+    * **Governance** - If the environment is installed in your infrastructure, select Customer Managed.

content/en/docs/management_guide/managing_service_accounts/_index.md

@@ -0,0 +1,12 @@
+---
+title: Managing service accounts
+linkTitle: Managing service accounts
+weight: 37
+date: 2023-09-13
+---
+
+Select **Environments** from the *Organization* left navigation menu. You can do the following with service accounts in the Amplify platform as an administrator:
+
+* View and edit service information.
+* Change the credential and secret details.
+* View and edit organization and team role assignment.

content/en/docs/management_guide/managing_service_accounts/adding_service_account_ui.md

@@ -0,0 +1,17 @@
+---
+title: Adding a service account with the UI
+linkTitle: Adding a service account with the UI
+weight: 10
+date: 2023-09-13
+---
+1. Sign into the Amplify platform and select **Organization** from the *User* dropdown menu.
+2. Click **Service Accounts** from the left navigation.
+3. Click **+ Service Account** at the top right.
+4. Complete the following fields:
+    * **Name** - Provide a name for your service account. If this account is used for usage reporting for one or more products and you intent to have different accounts for different environments, a good illustrative naming pattern could be `<product name>_<environment>_usage`.
+    * **Authentication Method** - Client Certificate or Client Secret. If this account is used for usage reporting, validate the authentication option the product supports.
+        * Select either to provide the credentials or have them platform generated.
+    * **Org Roles** - Select the role this service account should have. If this account is set up for usage reporting, select Usage Reporter.
+    * **Teams** - Select the roles the service account should have in the various teams. If this account is set up for usage reporting, no adjustments have to be made.
+5. Click **Save**. If you selected the authentication credentials to be platform generated, a dialog is displayed that allows you to view or copy the generated secret, or download the private key if you selected Client Certificate as the authentication option. Store the credential details, as this is the only time it will ever be displayed.
+6. Now that your service account has been created, use your client Id and secret or certificate to authenticate to the platform.

content/en/docs/management_guide/managing_service_accounts/downloading_service_account_definition_ui.md

@@ -0,0 +1,10 @@
+---
+title: Downloading a service account definition with the UI
+linkTitle: Downloading a service account definition with the UI
+weight: 20
+date: 2023-09-13
+---
+1. Sign into the Amplify platform and select **Organization** from the *User* dropdown menu.
+2. Click **Service Accounts** from the left navigation.
+3. Select one of the existing service account definitions by clicking on the name.
+4. Select the *download* option at the upper right to download the JSON structured definition of the environment.

content/en/docs/management_guide/managing_service_accounts/editing_service_account_ui.md

@@ -0,0 +1,17 @@
+---
+title: Editing a service account with the UI
+linkTitle: Editing a service account with the UI
+weight: 15
+date: 2023-09-13
+---
+1. Sign into the Amplify platform and select **Organization** from the *User* dropdown menu.
+2. Click **Service Accounts** from the left navigation.
+3. Select one of the existing Service Account definitions by clicking on the name.
+4. Edit any of the following values:
+    * **Name**
+    * **Description**
+    * **Credentials** - The original selected authentication method is locked.
+    * **Org Roles** - Select the role this service account should have. If this service account is set up for usage reporting, select Usage Reporter.
+    * **Teams** - Select the roles the service account should have in the various teams. If this account is set up for usage reporting, no adjustments have to be made.
+5. Click **Save**. If you selected the authentication credentials to be platform generated, a dialog is displayed that allows you to view or copy the generated secret, or download the private key if you selected Client Certificate as the authentication option. Store the credential details, as this is the only time it will ever be displayed.
+6. Now that your service account has been updated, use your client Id and secret or certificate to authenticate to the platform.