Skip to main content

Rancher

Integrate Rancher with Cloudaware to inventory clusters, projects, roles, and workloads for multi-cluster governance and reporting.

info
  • Audience: Cloudaware administrators, platform engineers, Kubernetes administrators, and cloud operations teams
  • Outcome: Rancher clusters, projects, RBAC, workloads, and related Kubernetes resources are available in CMDB for multi-cluster governance, ownership review, and reporting

Capabilities

The integration supports:

  • Read-only discovery of Rancher clusters, namespaces, RBAC, workloads, and related Kubernetes resources
  • Relationship mappings between Rancher workloads and assets in the CMDB
  • Search and reporting for Rancher objects using CMDB Navigator, CMDB list views, and reports

Prerequisites

Before you begin, make sure you have:

  • Access to a Cloudaware account.
  • A user with access to the Admin Console and permissions to manage cloud accounts, organizations, and integrations (Cloudaware Administrator).
  • Rancher server URL, public or private through TunHub.
  • Rancher API Key or Bearer Token with read access.

Add a Rancher Server to Cloudaware

  1. In Cloudaware, go to Admin.
  2. Find Rancher, then click + ADD.
  3. Enter the following values:
    • Name: A display name for the Rancher integration.
    • URL: The Rancher server URL
    • Hostname: The Rancher server URL or hostname.
    • API Key: The Rancher API Key or Bearer Token.
    • Trust Certificate: Enable this option for private endpoints accessed through TunHub, if required.
  4. Click Save.
  5. Confirm that the integration status indicator is green.
tip

Allow the initial discovery cycle to complete after enabling the integration.

View Rancher Data in CMDB

  1. In Cloudaware, open CMDB Navigator.
  2. In the left pane, select RANCHER.
  3. Open the Rancher cluster, namespace, workload, RBAC, or server object list to view records.

Supported Objects

Cloudaware ingests the following Rancher objects:

Rancher ObjectCMDB Object API Name
Rancher ClusterCA10R__CaRancherCluster__c
Rancher Cluster Config MapCA10R__CaRancherClusterConfigMap__c
Rancher Cluster Daemon SetCA10R__CaRancherClusterDaemonSet__c
Rancher Cluster DeploymentCA10R__CaRancherClusterDeployment__c
Rancher Cluster EndpointCA10R__CaRancherClusterEndpoint__c
Rancher Cluster HPACA10R__CaRancherClusterHpa__c
Rancher Cluster IngressCA10R__CaRancherClusterIngress__c
Rancher Cluster Limit RangeCA10R__CaRancherClusterLimitRange__c
Rancher Cluster NamespaceCA10R__CaRancherClusterNamespace__c
Rancher Cluster Network PolicyCA10R__CaRancherClusterNetworkPolicy__c
Rancher Cluster Network Policy RuleCA10R__CaRancherClusterNetworkPolicyRule__c
Rancher Cluster NodeCA10R__CaRancherClusterNode__c
Rancher Cluster Node AddressCA10R__CaRancherClusterNodeAddress__c
Rancher Cluster PodCA10R__CaRancherClusterPod__c
Rancher Cluster Pod ContainerCA10R__CaRancherClusterPodContainer__c
Rancher Cluster Pod Disruption BudgetCA10R__CaRancherClusterPodDisruptionBudget__c
Rancher Cluster Replica SetCA10R__CaRancherClusterReplicaSet__c
Rancher Cluster Resource QuotaCA10R__CaRancherClusterResourceQuota__c
Rancher Cluster RoleCA10R__CaRancherClusterRole__c
Rancher Cluster Role BindingCA10R__CaRancherClusterRoleBinding__c
Rancher Cluster Role Template BindingCA10R__CaRancherClusterRoleTemplateBinding__c
Rancher Cluster SecretCA10R__CaRancherClusterSecret__c
Rancher Cluster ServiceCA10R__CaRancherClusterService__c
Rancher Cluster Service AccountCA10R__CaRancherClusterServiceAccount__c
Rancher Cluster Service Account SecretCA10R__CaRancherClusterServiceAccountSecret__c
Rancher Cluster Stateful SetCA10R__CaRancherClusterStatefulSet__c
Rancher Cluster Storage ClassCA10R__CaRancherClusterStorageClass__c
Rancher Global RoleCA10R__CaRancherGlobalRole__c
Rancher Global Role BindingCA10R__CaRancherGlobalRoleBinding__c
Rancher ProjectCA10R__CaRancherProject__c
Rancher Project Role Template BindingCA10R__CaRancherProjectRoleTemplateBinding__c
Rancher Role TemplateCA10R__CaRancherRoleTemplate__c
Rancher ServerCA10R__CaRancherServer__c
Rancher UserCA10R__CaRancherUser__c

Troubleshooting

note

Initial data collection may take time to complete.

Authentication Failed or Integration Shows Red Status

  • Verify that the Rancher server URL or hostname is correct.
  • Confirm that the API Key or Bearer Token is valid, active, and has read access.
  • Check whether Trust Certificate is required for private endpoints accessed through TunHub.
  • Re-enter the API Key or Bearer Token by editing the integration in Cloudaware.

Rancher Objects Are Missing

  • Allow the initial discovery cycle to complete.
  • Confirm that the API Key or Bearer Token has access to the missing clusters, namespaces, workloads, or RBAC objects.
  • Validate cluster and namespace counts against Rancher.
  • In CMDB Navigator, verify that you are viewing the RANCHER section and related resources.

Private Endpoint Connection Fails

  • Confirm that the TunHub route to the Rancher server is configured and healthy.
  • Verify that the Rancher server is reachable from the internal host where the Cloudaware Breeze Agent is installed.
  • Confirm that the URL/Hostname value matches the endpoint exposed through TunHub.

Still stuck? Contact Cloudaware Support at support@cloudaware.com with the integration name and a brief description of the issue.

Reconfigure or Remove the Integration

warning

To rotate tokens or update endpoint settings, edit the existing integration instead of deleting and re-creating it.

Update the Integration Details

  1. Go to Admin.
  2. Select Rancher.
  3. Select the specific integration.
  4. Open the three-dot menu (), then click Edit.
  5. Update the required fields.
  6. Click Save.

Remove the Integration from Cloudaware

  1. Go to Admin.
  2. Select Rancher.
  3. Select the specific integration.
  4. Open the three-dot menu (), then click Delete.
  5. Confirm the deletion if prompted.

Security Notes

  • Use a dedicated Rancher API Key or Bearer Token with the minimum read permissions required for Cloudaware discovery.
  • Avoid using a personal administrator token for long-running integrations.
  • Store Rancher tokens only in approved credential stores and avoid sharing them through tickets, chat, or documentation.
  • Rotate Rancher tokens according to your organization's credential-rotation policy and immediately after suspected exposure.
  • Restrict TunHub routes to the specific Rancher endpoint and port required by the integration.
  • Review Rancher permissions regularly to confirm that Cloudaware can access only the clusters and resources required for discovery.
  • Update the Cloudaware Rancher integration immediately if the Rancher token is revoked, regenerated, or replaced.