Accessing your IBM Cloud Private cluster by using the management console
You can access your IBM Cloud Private cluster management console from a supported web browser.
Prerequesites
You must install IBM Cloud Private. View Installing IBM Cloud Private for more information.
-
Connect to the URL
<https://<Cluster Master Host>:<Cluster Master API Port>. See the following definitions:-
<Cluster Master Host>and<Cluster Master API Port>are defined in Master endpoints. -
The username and password are defined in the
config.yamlfile.
-
-
Access your cluster from a web browser. For a list of supported browsers, see Supported browsers.
If you configured IBM Multicloud Manager, you are directed to a URL with views for both IBM Cloud Private and IBM Multicloud Manager.
IBM Cloud Private management console components
Learn more about a few of the management console components that you can use to view, manage, or customize your management console.
Note: If you have IBM Multicloud Manager configured, you can access the IBM Cloud Private experience from Local cluster > Manage Local Cluster. The IBM Cloud Private management console from Manage Local Cluster opens in a new tab.
Without IBM Multicloud Manager configured, the navigation only displays IBM Cloud Private components. If you installed Vulnerability Advisor, Transformation Advisor, or a custom Helm chart, Add-ons is also an option in your navigation.
IBM Cloud Private management console components:
Getting started
From both IBM Cloud Private and IBM Multicloud Manager, you can view descriptions and tasks, and you can install various CLI tools.
From the Header, click the Help (?) icon to view the About page, the documentation, and more. From the User menu, you can access the Configure Client page.
Overview
Use the Overview page to manage and reorganize the dashboard of your cluster information. You can view details of your IBM Cloud Private clusters and other cloud service providers that IBM Cloud Private supports. You can also view details about your applications. The Overview dashboard is continuously refreshed in real time.
Reorganizing your dashboard
You can personalize your view of the Overview dashboard by reorganizing the resource overview cards. You can view the following information about your cluster(s):
- Name of the cloud service with the number of clusters
- Cluster compliance
- Pod details
- Pod status
- Cluster resources (VCPU/Memory usage)
- Storage usage
Viewing application details
You can view the information of each application. Click Show details to view the following information:
- Number of clusters
- Number of Kubernetes types
- Number of regions
- Number of nodes
- Number of pods
Viewing your pod health
View the pod health for all of your clusters by expanding the Heatmap. The Heatmap displays color-coordinated boxes that represent the VCPU usage threshold of your nodes.
Click Show details to view the map. The size of the color-coordinated boxes represent the amount of nodes on your cluster. Hover your cursor over the box to view the response time of your cluster.
Filtering your results
You can personalize the Overview page more with the filtering feature. Click Filter results to specify what information is displayed on your page.
Topology page
The Topology page uses information from Weave Scope probe to display Kubernetes objects within a cluster. If you have a hub cluster, you can view hub cluster resources. As you configure managed clusters, you see more clusters in the Topology view.
To reduce the graphics on the page, you can filter the view by Clusters, Namespaces, and Labels. You can also filter the design by selecting the icon that represents the Kubernetes objects.
Search
Note: Search is not supported for IBM Z users.
From both IBM Cloud Private and IBM Multicloud Manager, Search provides visibility into your Kubernetes resources across all your clusters.
You can only search for resources based on your access level. If you save and share a Search query with another user, returned results depend on access level for that user. For more information on role access, see Role-based access control.
Type a word in the Search bar, then Search finds for your Kubernetes resources that contain that value.
Your search options depend on your cluster objects. See the following examples: name, namespace, status, as well as other resource fields. Auto-complete provides suggestions to refine your search.
You can refine your results with specific fields. See the following example:
- Search for a single field, such as
kind:podto find all pod resources. - Search for multiple fields, such as
kind:pod namespace:defaultto find the pods in the default namespace.
You can also search with conditions using characters, such as (>, >=, <, <=, !=).
See the following example:
- Search for
kind:pod status:!Runningto find all pod resources where the status is notRunning. - Search for
kind:pod restarts:>1to find all pods that have restarted at least twice.
If you want to save your search, click the Save disk icon.
Policies
Use the Policies page to create and manage security policies that are defined for security controls that are enabled. See the following list of capabilities for the Policies dashboard:
- View security policy and cluster violations that exist.
- Remediate your security violations.
- Perform a root cause analysis of security violations.
- View security controls to each compliance certification controls.
- Configure security controls.
- Provide interfaces to pull data into other tools.
- View a summary of risk reports for each security control.
- View periodic security readiness reports.
Important: You must enable and manage all security controls and standards to the enterprise internal security, and external regulatory compliance standards for their IBM Cloud Private deployments.
Customize the Policies page by filtering the standards, categories, controls, and type of remediation.
From the Overview tab on the Policies page, you can view the Top Violations, which are cluster policies with the most violations. You can filter the Top Violations dashboard by the Clusters or Policies labels. You can also filter the Policy Overview dashboard by Categories or Standards.
From the All Policies tab, you can view a table of your policies. The following information about your policy is available in the table:
- Namespace
- Remediation
- Cluster Compliant
- Controls
- Standards
- Categories
Select a policy to view the following policy details:
- Policy Details
- Policy YAML Template
- Policy Status
- Policies
- Placement Policies
- Placement Bindings
See the following documentation to learn how to manage the Policies dashboard: