Cloudaware Documentation
Cloudaware Documentation
Breadcrumbs

Rancher

Rancher is the open source multi-cluster orchestration platform. This guide explains how to add Rancher integration to Cloudaware.

Rancher - CA_logo_black.png To see how Cloudaware seamlessly integrates with Rancher in action, request a demo.

Prerequisites


If the Rancher server runs in a private network, configure the TunHub gateway before adding Rancher integration to Cloudaware.

Create a custom role in Rancher


  1. Log in to the Rancher account. Go to Home → hamburger icon.

  2. Go to Users & Authentication → Role Template. Click Create Global Role.

    Rancher - Custom role in Rancher - role templates - create.png


  3. Configure the role:
    Set up a meaningful name for the role, e.g., CA Read Only.
    In ‘Verbs’, add get, list, and watch permissions.
    In 'Resource', set the scope as *.
    In 'New User Default', leave the radio button as is – No

    Rancher - Custom role in Rancher - create role - permissions.png


    Click Create.

  4. Go back to Users & Authentication → Users → select the user created for Cloudaware. Click the three-dots on the right → click Edit Config.

    Rancher - Custom role in Rancher - users - edit config.png


    In 'Custom', assign CA Read Only role to the Cloudaware user. Click Save.

    Rancher - Custom role in Rancher - create role - assign.png


    More about custom roles in Rancher here.


Add a Rancher server


  1. Log in to Cloudaware → Admin.

    Rancher - admin.png


  2. Find Rancher in integrations. Click +ADD.

    Rancher - admin - add Rancher integration.png


  3. Fill out the form:

    Rancher - Rancher integration details.png

    WHERE

    Name – a name for the Rancher integration
    URL – the Rancher server URL (if the Rancher server is running in a private network, use the TunHub URL generated by Cloudaware after a designated route is set up in TunHub integration, e.g. https://tunhub.cloudaware.com:1234)
    Hostname – the Rancher server hostname
    API Key – the Bearer Token. Read more
    Trust Certificate – check this box if the Rancher server is running in a private network, and TunHub gateway has been set up in Cloudaware

    Click CHECK to test the connection. Once the validation passed, click SAVE.

  4. A green light in the ‘Status’ column indicates successful configuration. If the light is red, contact support@cloudaware.com.

  5. To view Rancher-related data, go to Cloudaware CMDB Navigator. Select RANCHER in the left-hand menu.

    Rancher - Rancher objects in CMDB.png


List of Rancher objects 


Cloudaware supports the following Rancher objects:

  • Rancher Cluster CA10R__CaRancherCluster__c

  • Rancher Cluster Config Map CA10R__CaRancherClusterConfigMap__c

  • Rancher Cluster Daemon Set CA10R__CaRancherClusterDaemonSet__c

  • Rancher Cluster Deployment CA10R__CaRancherClusterDeployment__c

  • Rancher Cluster Endpoint CA10R__CaRancherClusterEndpoint__c

  • Rancher Cluster HPA CA10R__CaRancherClusterHpa__c

  • Rancher Cluster Ingress CA10R__CaRancherClusterIngress__c

  • Rancher Cluster Limit Range CA10R__CaRancherClusterLimitRange__c

  • Rancher Cluster Namespace CA10R__CaRancherClusterNamespace__c

  • Rancher Cluster Network Policy CA10R__CaRancherClusterNetworkPolicy__c

  • Rancher Cluster Network Policy Rule CA10R__CaRancherClusterNetworkPolicyRule__c

  • Rancher Cluster Node CA10R__CaRancherClusterNode__c

  • Rancher Cluster Node Address CA10R__CaRancherClusterNodeAddress__c

  • Rancher Cluster Pod CA10R__CaRancherClusterPod__c

  • Rancher Cluster Pod Container CA10R__CaRancherClusterPodContainer__c

  • Rancher Cluster Pod Disruption Budget CA10R__CaRancherClusterPodDisruptionBudget__c

  • Rancher Cluster Replica Set CA10R__CaRancherClusterReplicaSet__c

  • Rancher Cluster Resource Quota CA10R__CaRancherClusterResourceQuota__c

  • Rancher Cluster Role CA10R__CaRancherClusterRole__c

  • Rancher Cluster Role Binding CA10R__CaRancherClusterRoleBinding__c

  • Rancher Cluster Role Template Binding CA10R__CaRancherClusterRoleTemplateBinding__c

  • Rancher Cluster Secret CA10R__CaRancherClusterSecret__c

  • Rancher Cluster Service CA10R__CaRancherClusterService__c

  • Rancher Cluster Service Account CA10R__CaRancherClusterServiceAccount__c

  • Rancher Cluster Service Account Secret CA10R__CaRancherClusterServiceAccountSecret__c

  • Rancher Cluster Stateful Set CA10R__CaRancherClusterStatefulSet__c

  • Rancher Cluster Storage Class CA10R__CaRancherClusterStorageClass__c

  • Rancher Global Role CA10R__CaRancherGlobalRole__c

  • Rancher Global Role Binding CA10R__CaRancherGlobalRoleBinding__c

  • Rancher Project CA10R__CaRancherProject__c

  • Rancher Project Role Template Binding CA10R__CaRancherProjectRoleTemplateBinding__c

  • Rancher Role Template CA10R__CaRancherRoleTemplate__c

  • Rancher Server CA10R__CaRancherServer__c

  • Rancher User CA10R__CaRancherUser__c