Web console

Red Hat Advanced Cluster Management for Kubernetes 2.12

Console

Abstract

Read more to learn how to use the integrated console components.

Chapter 1. Web console

Learn how to access and use components of the Red Hat Advanced Cluster Management for Kubernetes console from the following documentation:

Accessing your console
Console overview

1.1. Console overview

Learn more about console components that you can use to view, manage, or customize your console.

See the following image of the Navigation from the Red Hat Advanced Cluster Management for Kubernetes console, which is described in more detail later in each section. See that the navigation represents major production function.

1.1.2. Home

From the Red Hat Advanced Cluster Management for Kubernetes Home page in the All clusters view, you can access more information and you can search across the product. Click Welcome for more introductory information about each product function.

1.1.2.1. Overview

Click Overview to see summary information, or to access clickable Cluster percentage values for policy violations, and more.

From the Overview page, you can view the following information:

Cluster and node counts across all clusters and for each provider
Cluster status
Cluster compliance
Pod status
Cluster add-ons

You can also access all APIs from the integrated console. From the local-cluster view, go to Home > API Explorer to explore API groups.

You can also use the Fleet view switch from the Overview page header to filter the page data by using cluster labels, and display metrics.

The following information is displayed from the Fleet view switch:

Number of clusters
Application types
Number of enabled policies on your cluster
Cluster version
Total number of nodes on your cluster
Number of worker cores

The following information from Red Hat Insights is displayed:

Cluster recommendations
Number of risk predictions
Cluster health which includes the status and violations
A view of your resources based on your custom query.

If observability is enabled, alert and failing operator metrics from across your fleet are also displayed.

To learn about Search, see Search in the console.

1.1.2.2. Command line tools

From the Home page, you can access Command Line Interface (CLI) downloads by using the following steps:

Click the ? icon in the toolbar of the console.
Click Command Line Tools from the drop-down menu.
Find the Advanced Cluster Management header to find a list of tools that are available for Red Hat Advanced Cluster Management, which is specified with the operating system and architecture.
Select the appropriate binary file to download and use on your local system.

1.1.3. Infrastructure

From Clusters, you can create new clusters or import existing clusters. From Automation, you can create an Ansible template.

For more information about managing clusters, see The multicluster engine operator cluster lifecycle overview.

Additionally, see specific information on these cluster types at Configuring Ansible Automation Platform tasks to run on managed clusters.

1.1.4. Applications

Create an application and edit a .yaml file. Access an overview or more advanced information about each application. For more information about application resources, see Managing applications.

1.1.5. Governance

Create and edit a .yaml file to create a policy. Use the Governance dashboard to manage policies and policy controllers.

For more information, see Governance.

1.1.6. Credentials

The credential stores the access information for a cloud provider. Each provider account requires its own credential, as does each domain on a single provider.

Review your credentials or add a credential.

See Managing credentials overview for more specific information about providers and credentials.

1.2. Accessing your console

The Red Hat Advanced Cluster Management for Kubernetes web console is integrated with the Red Hat OpenShift Container Platform web console as a console plug-in. You can access Red Hat Advanced Cluster Management within the OpenShift Container Platform console from the cluster switcher by selecting All Clusters. The cluster switcher is a drop-down menu that initially displays local-cluster.

Select local-cluster when you want to use OpenShift Container Platform console features on the cluster where you installed Red Hat Advanced Cluster Management. Select All Clusters when you want to use Red Hat Advanced Cluster Management features to manage your fleet of clusters.

If the cluster switcher is not present, the required console plug-ins might not be enabled. For new installations, the console plug-ins are enabled by default. If you upgraded from a previous version of Red Hat Advanced Cluster Management and want to enable the plug-ins, or if you want to disable the plug-ins, complete the following steps:

To disable the plug-in, be sure you are in the Administrator perspective in the OpenShift Container Platform console.
Find Administration in the navigation and click Cluster Settings, then click the Configuration tab.
From the list of Configuration resources, click the Console resource with the operator.openshift.io API group, which contains cluster-wide configuration for the web console.
Select the Console plug-ins tab. Both the acm and mce plug-ins are listed.
Modify plug-in status from the table. In a few moments, you are prompted to refresh the console.

Note: To enable and disable the console, see MultiClusterHub advanced for information.

To learn more about the Red Hat Advanced Cluster Management for Kubernetes console, see Console overview.

1.3. Enabling virtual machine actions (Technology Preview)

To view VirtualMachine resources across all the clusters that Red Hat Advanced Cluster Management for Kubernetes manages, use the Search feature to list and filter the VirtualMachine resources created with the Red Hat OpenShift Virtualization. You can also enable the following actions from the Red Hat Advanced Cluster Management console on your VirtualMachine resources:

Start
Stop
Restart
Pause
Unpause

Required access: Cluster administrator

1.3.1. Prerequisite

Confirm that the ManagedServiceAccount add-on is enabled. See ManagedServiceAccount add-on.

1.3.2. Enabling virtual machine actions for Red Hat Advanced Cluster Management

You can enable the virtual machine actions for Red Hat Advanced Cluster Management by updating the console config map. Complete the following steps:

To update the Red Hat Advanced Cluster Management console config map for enabling virtual machine actions, run the following command:
```
oc patch configmap console-mce-config -n multicluster-engine -p '{"data": {"VIRTUAL_MACHINE_ACTIONS": "enabled"}}'
```

To configure Red Hat Advanced Cluster Management to process the actions, create and configure a ManagedServiceAccount resource for each managed cluster. Save the following YAML file:

apiVersion: authentication.open-cluster-management.io/v1beta1
kind: ManagedServiceAccount
metadata:
  name: vm-actor
  labels:
    app: search
spec:
  rotation: {}
---
apiVersion: rbac.open-cluster-management.io/v1alpha1
kind: ClusterPermission
metadata:
  name: vm-actions
  labels:
    app: search
spec:
  clusterRole:
    rules:
      - apiGroups:
          - subresources.kubevirt.io
        resources:
          - virtualmachines/start
          - virtualmachines/stop
          - virtualmachines/restart
          - virtualmachineinstances/pause
          - virtualmachineinstances/unpause
        verbs:
          - update
  clusterRoleBinding:
    subject:
      kind: ServiceAccount
      name: vm-actor
      namespace: open-cluster-management-agent-addon

Note: You must repeat this step for each new managed cluster.

Apply the ManagedServiceAccount resource to your hub cluster by running the following command:
```
oc apply -n <MANAGED_CLUSTER> -f /path/to/file
```

The virtual machine actions are enabled for Red Hat Advanced Cluster Management.

1.3.3. Disabling virtual machine actions

To disable virtual machine actions for Red Hat Advanced Cluster Management, run the following command:

oc patch configmap console-mce-config -n multicluster-engine -p '{"data": {"VIRTUAL_MACHINE_ACTIONS": "disabled"}}'

The virtual machine actions are disabled for Red Hat Advanced Cluster Management.

1.3.4. Deleting ManagedServiceAccounts and ClusterPermissions resources

To delete ManagedServiceAccounts and ClusterPermissions resources that use virtual machine actions, complete the following steps:

To delete the resources, run the following command:

oc delete managedserviceaccount,clusterpermission -A -l app=search

You might receive the following output:

managedserviceaccount.authentication.open-cluster-management.io "vm-actor" deleted managedserviceaccount.authentication.open-cluster-management.io "vm-actor" deleted clusterpermission.rbac.open-cluster-management.io "vm-actions" deleted clusterpermission.rbac.open-cluster-management.io "vm-actions" deleted

To confirm that the clean up is complete, run the following command:
```
oc get managedserviceaccount,clusterpermission -A -l app=search
```
When the resources are deleted successfully, you receive the following message:
```
"No resources found"
```

The ManagedServiceAccounts and ClusterPermissions resources are deleted.

Legal Notice

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.