Skip to main content
Skip table of contents

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
Rancher Cluster Config Map
Rancher Cluster Daemon Set
Rancher Cluster Deployment
Rancher Cluster Endpoint
Rancher Cluster HPA
Rancher Cluster Ingress
Rancher Cluster Limit Range
Rancher Cluster Namespace
Rancher Cluster Network Policy
Rancher Cluster Network Policy Rule
Rancher Cluster Node
Rancher Cluster Node Address
Rancher Cluster Pod
Rancher Cluster Pod Container
Rancher Cluster Pod Disruption Budget
Rancher Cluster Replica Set
Rancher Cluster Resource Quota
Rancher Cluster Role
Rancher Cluster Role Binding
Rancher Cluster Role Template Binding
Rancher Cluster Secret
Rancher Cluster Service
Rancher Cluster Service Account
Rancher Cluster Service Account Secret
Rancher Cluster Stateful Set
Rancher Global Role
Rancher Global Role Binding
Rancher Project
Rancher Project Role Template Binding
Rancher Role Template
Rancher Server
Rancher User

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.