diff --git a/_data/sidebars/doc_sidebar.yml b/_data/sidebars/doc_sidebar.yml index f4c90beab..fe3bb2843 100755 --- a/_data/sidebars/doc_sidebar.yml +++ b/_data/sidebars/doc_sidebar.yml @@ -15,10 +15,6 @@ entries: url: /wavefront_introduction.html output: web - - title: "Subscription Types" - url: /subscriptions-differences.html - output: web - - title: Product FAQ output: web url: /tobs_faq.html @@ -27,18 +23,44 @@ entries: output: web folderitems: - - title: Start a Free Trial - url: /start_trial.html + - title: Subscription Types + url: /subscriptions-differences.html output: web - - title: Upgrade from Trial to Paid - url: /upgrade_and_purchase.html - output: web + subfolders: - - title: Purchase Additional Capacity - url: /purchase_additional_capacity.html + - title: Differences Explained + output: web + subfolderitems: + + - title: "UI Differences" + url: /csp-ui-differences.html + output: web + + - title: "Functionality Differences" + url: /csp-differences-by-area.html + output: web + + - title: Free Trial and Purchases + output: web + subfolderitems: + + - title: Start a Free Trial + url: /start_trial.html + output: web + + - title: Upgrade from Trial to Paid + url: /upgrade_and_purchase.html + output: web + + - title: Purchase Additional Capacity + url: /purchase_additional_capacity.html + output: web + + - title: "Onboarding Original to VMware Cloud Services" + url: /csp_migration.html output: web - + - title: Quickstart & Tutorials output: web folderitems: @@ -475,6 +497,10 @@ entries: - title: Integrations Overview url: /integrations.html output: web + + - title: How Integration Authentication Works + url: /integrations_onboarded_subscriptions.html + output: web - title: Complete List of Integrations url: /label_integrations%20list.html @@ -926,6 +952,14 @@ entries: - title: Manage Server to Server Apps url: /csp_server_to_server_apps.html output: web + + - title: Manage Service Accounts + url: /csp_service_accounts.html + output: web + + - title: Manage Tokens + url: /csp_api_tokens.html + output: web - title: Manage Access to Objects output: web diff --git a/images/csp-admin-tasks.png b/images/csp-admin-tasks.png new file mode 100644 index 000000000..9da838f7f Binary files /dev/null and b/images/csp-admin-tasks.png differ diff --git a/images/csp-api-token-apps.png b/images/csp-api-token-apps.png new file mode 100644 index 000000000..3cdf759fa Binary files /dev/null and b/images/csp-api-token-apps.png differ diff --git a/images/csp-api-token-user.png b/images/csp-api-token-user.png new file mode 100644 index 000000000..47e7278b1 Binary files /dev/null and b/images/csp-api-token-user.png differ diff --git a/images/csp-onboarding-flow.png b/images/csp-onboarding-flow.png new file mode 100644 index 000000000..f59ebc43e Binary files /dev/null and b/images/csp-onboarding-flow.png differ diff --git a/images/csp-replace-api-token.png b/images/csp-replace-api-token.png new file mode 100644 index 000000000..9529ab6cc Binary files /dev/null and b/images/csp-replace-api-token.png differ diff --git a/images/csp-replace-service-account.png b/images/csp-replace-service-account.png new file mode 100644 index 000000000..b82b39c4d Binary files /dev/null and b/images/csp-replace-service-account.png differ diff --git a/images/csp-user-accounts-migration.png b/images/csp-user-accounts-migration.png new file mode 100644 index 000000000..da7cf2e64 Binary files /dev/null and b/images/csp-user-accounts-migration.png differ diff --git a/images/csp_API_tokens.png b/images/csp_API_tokens.png new file mode 100644 index 000000000..e9601f695 Binary files /dev/null and b/images/csp_API_tokens.png differ diff --git a/images/csp_metrics_s_edit_rule.png b/images/csp_metrics_s_edit_rule.png new file mode 100644 index 000000000..d8b43d5f6 Binary files /dev/null and b/images/csp_metrics_s_edit_rule.png differ diff --git a/images/csp_sa_add_permission_global.png b/images/csp_sa_add_permission_global.png new file mode 100644 index 000000000..734f65b10 Binary files /dev/null and b/images/csp_sa_add_permission_global.png differ diff --git a/images/new-vs-original-accounts.png b/images/new-vs-original-accounts.png new file mode 100644 index 000000000..9306c2167 Binary files /dev/null and b/images/new-vs-original-accounts.png differ diff --git a/images/new-vs-original-menu.png b/images/new-vs-original-menu.png index aa1c89abc..f6fe7fece 100644 Binary files a/images/new-vs-original-menu.png and b/images/new-vs-original-menu.png differ diff --git a/images/user-management-comparison.png b/images/user-management-comparison.png new file mode 100644 index 000000000..38fc7090c Binary files /dev/null and b/images/user-management-comparison.png differ diff --git a/pages/doc/2020_10.x_release_notes.md b/pages/doc/2020_10.x_release_notes.md index ee14b1ff5..1549cff8e 100644 --- a/pages/doc/2020_10.x_release_notes.md +++ b/pages/doc/2020_10.x_release_notes.md @@ -32,7 +32,7 @@ If you are currently using an IAM Policy with Limited Access, review our changes Changes support more efficient and new APIs we are using. For example, in the next release (2010.14.x) we will start querying Cloudwatch using `cloudwatch:GetMetricData` API calls (instead of the older `cloudwatch:GetMetricStatistics` API calls). As a result, we can fetch multiple metrics in one API call and significantly reduce the number of API calls for retrieving metrics from AWS. - + ## Operators gt, lt, ge, le, eq, ne The new operators allow you to easily [filter on the query line](query_language_recipes.html#compare-with-operators-lt-gt-le-ge-eq-ne). You can use multiple operators, for example, to find values that are between specified values, as in this example: diff --git a/pages/doc/accounts-service.md b/pages/doc/accounts-service.md index b32d113cf..47980ac0f 100644 --- a/pages/doc/accounts-service.md +++ b/pages/doc/accounts-service.md @@ -7,7 +7,7 @@ permalink: service-accounts.html summary: Create and manage service accounts. --- -{% include note.html content="Starting July 3, 2023, VMware Aria Operations for Applications is a service on the VMware Cloud services platform. The content in this chapter is valid for **original** subscribers. For VMware Cloud services subscriptions, see [Manage Server to Server Apps](csp_server_to_server_apps.html)."%} +{% include note.html content="Starting July 3, 2023, VMware Aria Operations for Applications is a service on the VMware Cloud services platform. The content in this chapter is valid for **original** subscribers. For VMware Cloud services subscriptions, see [Manage Server to Server Apps](csp_server_to_server_apps.html) and [Manage Service Accounts](csp_service_accounts.html)."%} VMware Aria Operations for Applications (formerly known as Tanzu Observability by Wavefront) supports service accounts that can be used to automate management of objects such as dashboards, alerts, etc. A service account can't perform the **UI operations** that all user accounts can [perform by default](user-accounts.html#what-can-a-new-user-do). There's no limit on the number of service accounts that you can create in your organization. @@ -19,11 +19,11 @@ Each service account that you create is automatically added to the **Service Acc Service accounts are used for automating management tasks. -* A service account uses a **token** to authenticate. +* A service account uses an **API token** to authenticate. * Each account is automatically added to the **Service Accounts** group. If a role is assigned to that group, the service account gets the permissions from that role. * Service accounts can be added to any group to get that group's role (and permissions). -As a user with the **Accounts** permission, you [generate (and revoke, if needed)](api_tokens.html#generate-and-manage-the-api-tokens-for-a-service-account) authentication tokens for the service account. It’s also possible to deactivate a service account completely. +As a user with the **Accounts** permission, you [generate (and revoke, if needed)](api_tokens.html#generate-and-manage-the-api-tokens-for-a-service-account) API tokens for the service account. It’s also possible to deactivate a service account completely. ## How Service Accounts Work diff --git a/pages/doc/api_tokens.md b/pages/doc/api_tokens.md index 19de6d9bc..09fb63429 100644 --- a/pages/doc/api_tokens.md +++ b/pages/doc/api_tokens.md @@ -7,7 +7,7 @@ permalink: api_tokens.html summary: Learn how you can generate and manage API tokens in VMware Aria Operations for Applications (previously known as Tanzu Observability by Wavefront). --- -{% include note.html content="Starting July 3, 2023, VMware Aria Operations for Applications is a service on the VMware Cloud services platform. The content in this chapter is valid for **original** subscribers. VMware Cloud services subscriptions use VMware Cloud services API tokens. For details, see [Subscription Types](subscriptions-differences.html)."%} +{% include note.html content="Starting July 3, 2023, VMware Aria Operations for Applications is a service on the VMware Cloud services platform. The content in this chapter is valid for **original** subscriptions. For VMware Cloud services subscriptions, see [Manage Tokens](csp_api_tokens.html)."%} Before you can invoke the [REST API](wavefront_api.html) using `curl` or from an API client, you must have an API token. An API token is a string of hexadecimal characters and dashes. For example: diff --git a/pages/doc/csp_access.md b/pages/doc/csp_access.md index 302c59821..0964f9629 100644 --- a/pages/doc/csp_access.md +++ b/pages/doc/csp_access.md @@ -11,19 +11,14 @@ summary: Control access to individual dashboards and alerts. VMware Cloud services supports the roles and groups authorization paradigm for managing global permissions in VMware Aria Operations for Applications. For example, a user with the **Dashboards** service role can manage *all* dashboards in Operations for Applications. This paradigm is sufficient for many of our customers. -Users with the [**Super Admin** service role](csp_users_roles.html#operations-for-applications-service-roles-built-in) who need finer-grained control can manage access on a per-object basis. We currently support access control for dashboards and alerts. +Users with the **Admin** and **Super Admin** service roles who need finer-grained control can manage access on a per-object basis. We currently support access control for dashboards and alerts. {% include note.html content="Permission and access control are additive. To make changes to a dashboard, you must have a role with the **Dashboards** permission and **View and Modify** access for that dashboard." %} -{% include tip.html content="In addition to access control, Operations for Applications also support [metrics security policy rules](csp_metrics_security.html) which allow fine-grained control over which users can see which metrics." %} +{% include tip.html content="In addition to access control, Operations for Applications also supports [metrics security policy rules](csp_metrics_security.html) which allow fine-grained control over which users can see which metrics." %} -This video shows how to limit access for a dashboard, how to give access (share) that dashboard, and how to set the security setting. You can manage access for alerts the same way. -Note that this video was created in 2020 and some of the information in it might have changed. It also uses the 2020 version of the UI. - -
- -{% include note.html content="After the access setting is set to **Object Creator** in an environment, only the creator of a new object and the users with **Super Admin** service role can view and modify new objects initially. Those users can give access to the object with other groups or users." %} +{% include note.html content="After the access setting is set to **Object Creator** in an environment, only the creator of a new object and users the **Super Admin** service role can view and modify new objects initially. Those users can give access to the object with other groups or users." %} ## How Access Control Works @@ -37,10 +32,10 @@ Operations for Applications supports granting and revoking access to dashboards - Restrict or grant access for individual alerts from the Alerts browser. - Click the **Share** icon on individual alerts to change who has access. -In high-security environments, users with the **Super Admin** service role can change the security setting to **Object Creator**. After that change: -* Each *new* object (dashboard or alert) is visible only to the creator of the object and to the users with the **Super Admin** service role with enabled Super Admin mode. +In high-security environments, users with the **Admin** and **Super Admin** service roles can change the security setting to **Object Creator**. After that change: +* Each *new* object (dashboard or alert) is visible only to the creator of the object and to the users with the **Admin** service role. * The object creator and the users with the **Super Admin** service role can then share new dashboards with groups or users. -* If a user with the **Super Admin** service role changes the security setting back to allow **Everyone** access, then the objects that were created while the strict security setting was set, continue to be governed by access control. +* If a user with the **Admin** or **Super Admin** service role changes the security setting back to allow **Everyone** access, then the objects that were created while the strict security setting was set, continue to be governed by access control. ## Change Access for One or More Dashboards or Alerts @@ -79,17 +74,18 @@ Initially, all users can *view* all dashboards and alerts. In addition, global p * Users with **Dashboards** permission can modify all dashboards. * Users with **Alerts** permission can modify all alerts. -As a user with the **Super Admin** service role, you can restrict access for new dashboards and alerts: +As a user with the **Admin** or **Super Admin** service role, you can restrict access to new dashboards and alerts: -1. Log in to your service instance and [enable Super Admin mode](csp_users_account_managing.html#enable-or-disable-super-admin-mode). +1. Log in to your service instance. +1. If you are a **Super Admin** user, [enable Super Admin mode](csp_users_account_managing.html#enable-or-disable-super-admin-mode). 1. From the gear icon on the toolbar, select **Organization Settings**. 2. Click the **Security** tab and select **Object Creator**. -After the change, access to new dashboards and new alerts is initially limited to the dashboard creator and the users with the **Super Admin** service role. Those users can share the objects with groups or individual users by giving **View** access or **View & Modify** access. +After the change, access to new dashboards and new alerts is initially limited to the dashboard creator and the users with the **Admin** or **Super Admin** service roles. Those users can share the objects with groups or individual users by giving **View** access or **View & Modify** access. -{% include note.html content="A change to the security setting applies only to dashboards and alerts created after the change. If you change the setting to **Object Creator**, only new dashboards and alerts have restricted access. If you later change the setting to **Everyone**, all dashboards and alerts that were created while the setting was **Object Creator** keep the restricted access." %} +{% include note.html content="A change to the security setting applies only to dashboards and alerts created **after** the change. If you change the setting to **Object Creator**, only new dashboards and alerts have restricted access. If you later change the setting to **Everyone**, all dashboards and alerts that were created while the setting was **Object Creator** keep the restricted access." %} -By default, service accounts (which correspond to server to server apps in VMware Cloud services) don't have browse permissions. However, you can also grant access for new dashboards and alerts to service accounts: +By default, service accounts (which includes the [server to server apps](csp_server_to_server_apps.html) in VMware Cloud services as well as the [service accounts](csp_service_accounts.html) in Operations for Applications) don't have browse permissions. However, you can also grant access for new dashboards and alerts to service accounts: 1. From the gear icon on the toolbar, select **Organization Settings**. 2. Click the **Security** tab, select **Grant Modify Access To: Everyone** and **Service Accounts**. @@ -101,7 +97,7 @@ If you can no longer access a dashboard or alert, it was either deleted (moved t * If a dashboard was deleted and moved to trash less than 30 days ago, a user with the **Dashboards** permission can [restore the deleted dashboard](ui_dashboards.html#delete-and-recover-a-deleted-dashboard). * If an alert was deleted and moved to trash less than 30 days ago, a user with the **Alerts** permission can [restore the deleted alert](alerts_manage.html#restore-a-deleted-alert). * If a dashboard was deleted and moved to trash more than 30 days ago, or was permanently deleted, and no one, including users with the **Super Admin** service role, can find the dashboard. A user with the **Super Admin** can attempt to [restore the dashboard by using the API](#recover-a-permanently-deleted-dashboard). -* If the access settings to a dashboard or alert have changed, you can ask a user with the **Super Admin** service role to [restore the access for you](#changing-access-for-individual-dashboards-or-alerts). +* If the access settings to a dashboard or alert have changed, you can ask a user with the **Admin** or **Super Admin** service role to [restore the access for you](#changing-access-for-individual-dashboards-or-alerts). * If all users and groups can no longer access a specific dashboard or alert, a user with the **Super Admin** service role may need to check if it is in an orphaned state. A user with the **Super Admin** service role can [make orphan dashboards and alerts visible](#make-orphan-dashboards-or-alerts-visible). Only a user with the **Super Admin** service role can restore dashboard permissions and attempt to restore a permanently deleted dashboard. @@ -125,10 +121,10 @@ A permanently deleted dashboard does not show in the trash and becomes inaccessi 2. From the gear icon on the toolbar, select **API Documentation**. 3. Expand the **Dashboard** category and click the `GET api/v2/dashboard/{id}/history/{version}` request. 4. Enter the dashboard name as the `"id"` parameter. - For example, if the dashboard URL is `https://Field | Description |
---|---|
+Account ID | +ID of the account. We prefix this ID with sa::. A service account name must be unique. Operations for Applications converts a service account ID to lower case to avoid confusion that can result from almost identical account names (e.g. Service-1 and service-1). Users can type upper case or lower case. |
+
+Tokens | +List of API tokens that the service account can use to authenticate to the Operations for Applications service instance.
+
|
+
Permissions | +Individual permissions assigned to this service account. Assign the service account with the Proxies permission, so that you can use it for the proxy setup of an integration that authenticates with an Operations for Applications API token. | +
+To activate or deactivate an account from the Service Accounts page:
+
|
++ |
+To activate or deactivate an account from the Edit Service Account page:
+
|
++ |
+To grant or revoke permissions from the Service Accounts page:
+
|
++ |
+To grant or revoke permissions from the Edit Service Account page:
+
|
++ |
Task | Original Subscription | VMware Cloud Services Subscription |
---|---|---|
Upgrade from trial + | +
+
|
+
+
|
+
Purchase more PPS + | +
+
|
+
+
|
+
Invite new Super Admins + | +
+
|
+
+
|
+
Create and manage service accounts and their Operations for Applications API tokens + | +
+
|
+
+
|
+
Restore orphan dashboards and alerts + | +
+
|
+
+
|
+
Restrict access to new dashboards and alerts + | +
+
|
+
+
|
+
Set the service organization settings + | +
+
|
+
+
|
+
Functionality | Original Subscription | VMware Cloud Services Subscription |
---|---|---|
User Login + | +Users log in to their Operations for Applications service instance by using the URL of the service cluster, https://<your_instance>.wavefront.com , and their Operations for Applications accounts. If their corporate domain is configured for SAML SSO with Operations for Applications, users log in with their corporate accounts.
+ |
+Users log in to their Operations for Applications service instance through the VMware Cloud Services Console with their VMware Cloud services accounts. If their corporate domain is federated with VMware Cloud services, users log in with their corporate accounts. For details, see Log In from the VMware Cloud Services Console. + | +
User Accounts Management + | +
+Who: Users with the Accounts permission.
+ Where: In the Operations for Applications user interface. +How: You can invite new users with or without assigning roles and permissions. For details, see Manage User Accounts. + |
+
+Who: Users with the VMware Cloud Organization Owner or Organization Administrator role.
+ Where: In the VMware Cloud Services Console. +How: To add a user to your Operations for Applications service instance, you must assign that user: +
|
+
Service Accounts and Server to Server OAuth Apps Management + | +Note: Only service accounts are supported.
+ Who: Users with the Accounts permission. +Where: In the Operations for Applications user interface. +How: Service accounts authenticate with API tokens. Service accounts can be assigned with roles and permissions, as well as can be added to groups. For details, see Manage Service Accounts. + |
+Note: Server to server OAuth apps are recommended and fully supported. Service accounts are with limited support and will be deprecated in the future.
+ Who: +
Where: +
How: +
|
+
Permissions Management + | +Who: Users with the Accounts permission.
+ Where: In the Operations for Applications user interface. +How: Permissions can be assigned to roles as well as to individual user accounts and service accounts. +See: + +Note: The permissions list includes the Accounts, SAML IdP Admin, and API token permissions, because they are required for all of the authorization and authentication tasks which are done in the Operations for Applications. +In addition, the Accounts permission grants privileges for managing the Operations for Applications organization settings. +See the Permissions Reference. + |
+Who:
+
Where: +
How: Permissions can be assigned only to roles in the VMware Cloud services organization and service accounts - in the Operations for Applications environment. +See: + + +Note: The Accounts, SAML IdP Admin, and API token permissions don't exist, because most of the authorization and authentication tasks requiring these permissions are done in the VMware Cloud Services Console. +The Admin Operations for Applications permission grants privileges for managing service accounts, Operations for Applications API tokens, and the Operations for Applications organization settings. +See the Operations for Applications Permissions in VMware Cloud Services. + |
+
Roles Management + | +Who: Users with the Accounts permission.
+ Where: In the Operations for Applications user interface. +How: Roles can be assigned with permissions. Roles can be assigned to user accounts, service accounts, and groups. For details, see Manage Roles and Permissions. + |
+
+Who: Users with the VMware Cloud Organization Owner or Organization Administrator role.
+ Where: In the VMware Cloud Services Console. +How: Roles can be assigned with permissions. Roles can be assigned to users, groups, API tokens, and server to server apps. There are: +
|
+
Groups Management + | +Who: Users with the Accounts permission.
+ Where: In the Operations for Applications user interface. +How: A group of user and service accounts can be assigned with one or more roles. For details, see Create a Group. + |
+
+Who: Users with the VMware Cloud Organization Owner or Organization Administrator role.
+ Where: In the VMware Cloud Services Console. +How: A group of users can be assigned with organization and service roles. A group can be shared with other VMware Cloud organizations. In a federated environment, you can add enterprise groups from your corporate domain. For details, see How do I work with groups in the VMware Cloud services documentation. + |
+
Self-Service SAML SSO | +
+Who: Users with the SAML IdP Admin permission.
+ Where: In the Operations for Applications user interface. +How: Operations for Applications includes predefined authentication integrations. For details, see Single-Tenant Authentication and Self-Service SAML SSO. + |
+
+Who: A user with the VMware Cloud Organization Owner role together with an Enterprise Administrator.
+ Where: In the VMware Cloud Services Console. +How: The VMware Cloud Organization Owner user kicks off the self-service federation workflow on behalf of the VMware Cloud organization and invites the Enterprise Administrator to complete the setup. For details, see Setting Up Enterprise Federation with VMware Cloud Services Console in the VMware Cloud services documentation. + |
+
Generating API Tokens + | +Note: Only Operations for Applications API tokens are supported.
+ Who: +
Where: In the Operations for Applications user interface. +How:
|
+Note: It is recommended to use VMware Cloud services API tokens and server to server OAuth app credentials for obtaining VMware Cloud services access tokens. Operations for Applications API tokens are with limited support and will be deprecated in a future release.
+ Who: +
Where: +
How: +
|
+
API Tokens Management | +
+Who:
+
Where: In the Operations for Applications user interface. +How:
|
+
+Who:
+
Where: +
How: +
|
+
Operations for Applications REST API Access | +
+Who: Everyone who has an Operations for Applications API token associated with a user account or a service account.
+ Where: An API client. +How: Interacting with the Operations for Application REST API requires an Operations for Application API token. +
|
+
+Who: Everyone who has a VMware Cloud services API token or the credentials of a server to server OAuth app.
+ Where: An API client. +How: Interacting with the Operations for Application REST API requires a VMware Cloud services access token. +
|
+
Operations for Applications Organization Settings | +
+Who: Users with the Accounts permission.
+ Where: In the Operations for Applications user interface. +How: As a user with the Accounts permission, you can configure: +
|
+
+Who: Users with the Admin Operations for Applications service role.
+ Where: In the Operations for Applications user interface. +How: As a user with the Admin service role, you can configure: +
|
+
Wavefront Proxy Installation + | +Note: The Wavefront proxy authenticates with an Operations for Applications API token.
+ Who: Users with the Proxies permission. +Where: In the Operations for Applications user interface. +How: As a user with the Proxies permission, you must configure the proxy to authenticate to Operations for Applications with an Operations for Applications API token that have the Proxies permission. For details, see Install a Proxy from the UI. + |
+Note: The Wavefront proxy authenticates with a VMware Cloud services access token obtained from server to server OAuth app credentials or from a VMware Cloud services API token. Proxy authentication with an Operations for Applications API token is still possible and supported only for a limited list of integrations.
+ Who: +
Where: +
How: As a user with the Proxies service role, you configure the proxy to authenticate to Operations for Applications. The proxy obtains a VMware Cloud services access token with the Proxies service role or use an Operations for Applications API token of a service account with the Proxies permission. To obtain a VMware Cloud services access token: +
|
+
Integrations Installation + | +Note: All integrations that use a Wavefront proxy authenticate with an Operations for Applications API token.
+ Who: Users or service accounts with the Proxies permission who have an active Operations for Applications API token. +Where: In the Operations for Applications user interface. +How: Follow the instructions on the Setup tab of the integration that you want to install. + |
+Note: Most of the integrations that use a Wavefront proxy authenticate with a VMware Cloud services access token. A limited list of integrations still use proxy authentication with an Operations for Applications API token.
+ Who: Users with the Proxies Operations for Applications service role who must have one of the following: +
Where: In the Operations for Applications user interface. +How: Follow the instructions on the Setup tab of the integration that you want to install. + |
+
Metrics Security Policy Management + | +Who: Users with the Metrics permission.
+ Where: In the Operations for Applications user interface. +How: Privileged users can block or allow access to metrics for: +
|
+Who: Users with the Metrics Operations for Applications service role.
+ Where: In the Operations for Applications user interface. +How: Privileged users can block or allow access to metrics for: +
|
+
@@ -36,9 +36,7 @@ Metrics security policy rules allows fine-grained support for limiting access to With a metrics security policy, you can block or allow access: * To metrics, optionally filtered by source or point tag -* Based on individual accounts ([user accounts](csp_user_management.html) and [service accounts](csp_server_to_server_apps.html)) or [groups](csp_users_roles.html#manage-user-groups). - -{% include note.html content="Service accounts in Operations for Applications correspond to server to server apps in VMware Cloud services." %} +* Based on individual accounts - [user accounts](csp_user_management.html) and service accounts (which includes the [server to server apps](csp_server_to_server_apps.html) in VMware Cloud services as well as the [service accounts](csp_service_accounts.html)), or [groups](csp_users_roles.html#manage-user-groups). When an account attempts to access metrics, the backend looks at the rules in priority order. Higher priority rules overwrite lower priority rules. @@ -181,7 +179,7 @@ Before you create rules, plan your strategy. * **Metrics Dimensions** allow you to determine what to block or allow. - Specify one or more metric prefixes. You can specify an exact match (e.g. `requests` or `request.`) or a wildcard match (e.g. `*.cpu.loadavg.*`, `cpu.*`). - Specify a combination of metric sources or point tags to narrow down the metrics. For example, you can block visibility into production environments for some developers, or you can block some development environments metrics for contractors. -* **Access** allows you to allow or block access for a combination of accounts (user accounts and service accounts) or groups. +* **Access** allows you to allow or block access for a combination of accounts (user accounts, server to server apps, and service accounts) or groups. See the Examples further below. @@ -207,7 +205,7 @@ You create a metrics security policy rule following these steps. See the annotat Here's an annotated screenshot that shows the main actions: -![Annotated Edit Rule screenshot. Highlights Press Enter in Prefix / Source and Point Tag section](images/metrics_s_edit_rule.png) +![Annotated Edit Rule screenshot. Highlights Press Enter in Prefix / Source and Point Tag section](images/csp_metrics_s_edit_rule.png) diff --git a/pages/doc/csp_migration.md b/pages/doc/csp_migration.md new file mode 100644 index 000000000..91833f1d4 --- /dev/null +++ b/pages/doc/csp_migration.md @@ -0,0 +1,417 @@ +--- +title: Onboarding Original Subscriptions to VMware Cloud Services +keywords: administration +tags: [administration] +sidebar: doc_sidebar +permalink: csp_migration.html +summary: Learn about how we migrate the authorization and authentication from Operations for Applications to VMware Cloud services. +--- + +Starting July 3, 2023, VMware Aria Operations for Applications is a service on the VMware Cloud services platform. We are in the process of incrementally onboarding all original subscriptions to VMware Cloud services. + +## What Should I Do Before the Onboarding? + +Currently, all original Operations for Applications subscriptions are integrated with VMware Cloud services for billing and subscription management. Therefore, you must already have a [VMware Cloud organization](csp_getting_started.html#whats-a-vmware-cloud-organization) with at least one user with the [VMware Cloud **Organization Owner** role](csp_getting_started.html#whats-a-vmware-cloud-organization-role). + +Before the onboarding: +* Get familiar with the VMware Cloud service platform. See [Getting Started with Operations for Applications on VMware Cloud Services](csp_getting_started.html). +* Verify that your VMware Cloud **Organization Owner** user can log in to the [VMware Cloud Services Console](https://console.cloud.vmware.com). + + - If you are the VMware Cloud **Organization Owner** user and cannot log in, try using the **Forgot Password** option. + - If your VMware Cloud **Organization Owner** user is unreachable or you don't know the name of your VMware Cloud **Organization Owner** user, contact our Technical Support team for assistance. +* If you have a [SAML SSO integration](auth_self_service_sso.html), as a VMware Cloud **Organization Owner** user, you must federate your currently integrated enterprise domain with your VMware Cloud organization. For details, see the [Setting Up Enterprise Federation with VMware Cloud Services Guide](https://docs.vmware.com/en/VMware-Cloud-services/services/setting-up-enterprise-federation-cloud-services/GUID-76FAECB3-CFAA-461E-B9C9-2A49C39CD17F.html) in the VMware Cloud services documentation. + + {% include warning.html content="If you do not federate your currently integrated enterprise domain, after onboarding to VMware Cloud services all users will lose access to the service."%} + +
+ + + + + + +After onboarding to VMware Cloud services, you should incrementally replace your service accounts in Operations for Applications with server to server OAuth apps in VMware Cloud services. + + The flowchart on the right shows the overall process for creating a server to server OAuth app and replacing a service account with it. + |
++ + | +
Scope + | +Description + | +
+ Organization Role + | +Organization Member is sufficient in most of the cases. + | +
+ Custom Roles + | +Optional. Use only if you previously created a custom role with the necessary Operations for Applications permissions. + | +
Service Roles + | +Required for service access. Assign the Operations for Applications service roles that correspond to the permissions of the service account that you want to replace.
+ If you already assigned a custom role, you must assign at least the Viewer Operations for Applications service role. + |
+
+ + +You should incrementally replace your Operations for Applications API tokens with the more secure VMware Cloud services access tokens. + +To replace an Operations for Applications API token associated with a service account, you must replace the service account with a server to server OAuth app. See [How to Replace a Service Account with a Server to Server App?](csp_migration.html#how-to-replace-a-service-account-with-a-server-to-server-app). + +The flowchart on the right shows the overall process for replacing an Operations for Applications API token with a VMware Cloud services API token. + |
++ + | +
Scope + | +Description + | +
+ Organization Role + | +Organization Member is sufficient in most of the cases. + | +
+ Custom Roles + | +Optional. Use only if you have assigned a custom role. + | +
Service Roles + | +Required for service access.
+ If you already assigned a custom role, you must assign at least the Viewer Operations for Applications service role. + |
+
Area | Original Subscription | VMware Cloud Services Subscription |
---|---|---|
User Login - | -Users log in to their Operations for Applications service instance by using the URL of the service cluster, https://<your_instance>.wavefront.com . and their Operations for Applications accounts. If their corporate domain is configured for SAML SSO with Operations for Applications, users log in with their corporate accounts.
- |
-Users log in to their Operations for Applications service instance through the VMware Cloud Services Console with their VMware Cloud services accounts. If their corporate domain is federated with VMware Cloud services, users log in with their corporate accounts. For details, see Log In from the VMware Cloud Services Console. - | -
Permissions - | -The Accounts, SAML IdP Admin, and API token permissions exist, because all of the authorization and authentication tasks requiring these permissions are done in the Operations for Applications UI. See the Permissions Reference. - | -The Accounts, SAML IdP Admin, and API token permissions don't exist, because all of the authorization and authentication tasks requiring these permissions are done in the VMware Cloud Services Console. See the Operations for Applications Permissions in VMware Cloud Services. - | -
Roles and Permissions Management - | -Who: Users with the Accounts permission.
- Where: In the Operations for Applications user interface. -How: Permissions can be assigned to roles as well as to individual users and service accounts. Roles can be assigned to user accounts, service accounts, and groups. For details, see: - - |
-
-Who: Users with the VMware Cloud Organization Owner or Organization Administrator role.
- Where: In the VMware Cloud Services Console. -How: Permissions can be assigned only to roles. Roles can be assigned to users, groups, API tokens, and server to server apps. There are built-in Operations for Applications service roles, which are not editable. Custom roles can be created and assigned with permissions for one or more services. For details, see Manage Roles. - |
-
User Accounts Management - | -
-Who: Users with the Accounts permission.
- Where: In the Operations for Applications user interface. -How: You can invite new users with or without assigning roles and permissions. For details, see Manage User Accounts. - |
-
-Who: Users with the VMware Cloud Organization Owner or Organization Administrator role.
- Where: In the VMware Cloud Services Console. -How: To add a user to your Operations for Applications service instance, you must assign that user: -
|
-
Self-Service SAML SSO | -
-Who: Users with the SAML IdP Admin permission.
- Where: In the Operations for Applications user interface. -How: Operations for Applications includes predefined authentication integrations. For details, see Single-Tenant Authentication and Self-Service SAML SSO. - |
-
-Who: A user with the VMware Cloud Organization Owner role together with an Enterprise Administrator.
- Where: In the VMware Cloud Services Console. -How: The VMware Cloud Organization Owner user kicks off the self-service federation workflow on behalf of the VMware Cloud organization and invites the Enterprise Administrator to complete the setup. For details, see Setting Up Enterprise Federation with VMware Cloud Services Console in the VMware Cloud services documentation. - |
-
Service Accounts and Server to Server Apps Management - | -
-Who: Users with the Accounts permission.
- Where: In the Operations for Applications user interface. -How: Service accounts authenticate with API tokens. Service accounts can be assigned with roles and permissions, as well as can be added to groups. For details, see Manage Service Accounts. - |
-
-Who: Users with the VMware Cloud Organization Owner role or the Developer additional role.
- Where: In the VMware Cloud Services Console. -How: Server to server OAuth apps in VMware Cloud services correspond to service accounts in Operations for Applications. A server to server app authenticates with OAuth credentials (ID and secret) and an access token is directly issued to the app. To add a service account to your Operations for Applications service instance, you must create a server to server OAuth app and assign that app: -
|
-
Groups Management - | -Who: Users with the Accounts permission.
- Where: In the Operations for Applications user interface. -How: A group of user and service accounts can be assigned with one or more roles. For details, see Create a Group. - |
-
-Who: Users with the VMware Cloud Organization Owner or Organization Administrator role.
- Where: In the VMware Cloud Services Console. -How: A group of users can be assigned with organization and service roles. A group can be shared with other VMware Cloud organizations. In a federated environment, you can add enterprise groups from your corporate domain. For details, see How do I work with groups in the VMware Cloud services documentation. - |
-
Generating API Tokens - | -
-Who: Depends on whether the API token is associated with a user account or a service account.
-
Where: In the Operations for Applications user interface. -How:
|
-
-Who: All users.
- Where: In the Cloud Services Console user interface. -How: Each user can generate VMware Cloud services API tokens for their user account. An API token can be assigned with roles from the list of roles that the user owns - organization roles, service roles, and custom roles. -For access to Operations for Applications, the VMware Cloud services API token must be assigned with an Operations for Applications service role and, optionally, a custom role with an Operations for Applications permission. -For details and instructions, see How do I generate API tokens in the VMware Cloud services documentation. - |
-
API Tokens Management | -
-Who:
-
Where: In the Operations for Applications user interface. -How:
|
-
-Who:
-
Where: In the Cloud Services Console user interface. -How:
|
-
Operations for Applications REST API Access | -
-Who: User and service accounts with an Operations for Applications API token.
- Where: An API client. -How: Interacting with the Operations for Application REST API requires an Operations for Application API token. -
|
-
-Who: Users with a VMware Cloud services API token and server to server apps with OAuth credentials (ID and secret).
- Where: An API client. -How: Interacting with the Operations for Application REST API requires a VMware Cloud services access token. -
|
-
Operations for Applications Organization Settings | -
-Who: Users with the Accounts permission.
- Where: In the Operations for Applications user interface. -How: As a user with the Accounts permission, you can configure: -
|
-
-Who: Users with the Super Admin Operations for Applications service role and Super Admin mode enabled.
- Where: In the Operations for Applications user interface. -How: As a user with the Super Admin service role, you can configure: -
|
-
Wavefront Proxy Authentication - | -Who: Users with the Proxies permission.
- Where: In the Operations for Applications user interface. -How: As a user with the Proxies permission, you must configure the proxy to authenticate to Operations for Applications with an Operations for Applications API token that have the Proxies permission. For details, see Install a Proxy from the UI. - |
-Who:
Where:
How: As a user with the Proxies permission, you must configure the proxy to authenticate to Operations for Applications. The proxy must retrieve a VMware Cloud services access token with the Proxies service role. There are two supported authentication types: -
|
-
Metrics Security Policy Rules - | -Who: Users with the Metrics permission.
- Where: In the Operations for Applications user interface. -How: Privileged users can block or allow access to metrics for: -
|
-Who: Users with the Metrics Operations for Applications service role or a custom role with the Metrics permission.
- Where: In the Operations for Applications user interface. -How: Privileged users can block or allow access to metrics for: -
|
-
Integrations - | -All integrations are still supported. See the List of Integrations. - | -You still can see, but cannot configure some of our integrations. For the list of integrations that we support when your Operations for Applications service is onboarded to VMware Cloud services, see Integrations Supported for Onboarded Subscriptions. - | -
Zabbix | [Zabbix Integration](zabbix.html) | -
Special Service Role | +Service Role | Description |
---|---|---|
When users with that service role enable Super Admin mode, they:
Tip: Combine the Super Admin service role with the roles that you want the user to have when Super Admin mode is disabled. |
Users with that service role:
|
+
+
You can also select the Everyone internal system group (which includes all users) or the Service Accounts internal system group (which includes all server to server apps that have access to your service as well as all service accounts in your service).