Skip to main content
Version: 3.4

Rancher

The Platform provides several points of integration with Rancher, which is a multi-cluster orchestration platform for Kubernetes. This Rancher integration is designed to help users manage the entire lifecycle of vClusters.

Firstly, the Rancher integration can be enabled on a per-project basis. This allows the admins to configure the Rancher Project ID and Rancher Cluster ID to which the project should be mapped. Subsequently, any virtual clusters within the project can be selectively imported into Rancher. Importing a virtual cluster means that it is available for use as a cluster within Rancher. You can enable member Synchronization which synchronizes Rancher Project Member Roles into Loft Project Member roles and Rancher Cluster Roles. There a couple of mappings available by default but you can define your own custom mappings.

Prerequisites​

Before you begin, make sure you have the following:

  • A running Loft instance
  • A running Rancher instance
  • A Rancher admin Bearer Token to allow the controller to access and perform actions in Rancher
Bearer Token

The bearerToken to be used should have a long expiration or must be rotated using an external mechanism as it will be used for every call to the Rancher API

Setup​

Global Rancher Config​

You must update the Loft configuration with the Rancher object to set up a global Rancher integration. This enables the platform to communicate with Rancher via its API and perform the necessary actions required for the syncing. This also enables SSO, so you can login to the platform via Rancher.

  1. Log in to the Platform UI as admin and navigate to the Admin section using the menu on the left.
  2. Edit the configuration by adding the Rancher object with the following properties:
    auth:
      rancher:
        host: your-rancher-instance
        bearerToken: "your-rancher-token"
        insecure: <true/false>
    Don't forget to change default values

    Replace your-rancher-instance with the address of your Rancher instance without protocol prefix, e.g. my-rancher.demo.dev

    Replace "your-rancher-token" with the bearerToken to be used. Its usually of the format Access Key: Secret Key e.g. "token-28kg6:gl5nqsq2hmxmdxr7fvcpfz2hh2krzvqff5w78kxr4tvc6r6x6s67t4"

    For further configuration options, see the Loft configuration reference and the Rancher configuration options.

  3. Save the changes to the configuration using the button and wait for the platform to restart.

Project-Based Rancher Integration​

To enable the integration for this Project and configure the project in Rancher to which this project must be associated, follow these instructions:

  1. From the Projects Navigator in the left hand pane, switch to the Project for which you wish to enable the integration. Click on the drop-down and click on .
  2. Click on Rancher
  3. Toggle the Enable Rancher Integration switch to enable synchronization for this project. Additional configuration options will appear.
  4. Under the Connect to Rancher, specify the Rancher Project ID and Rancher Cluster ID.
    To get the cluster ID click on 'Cluster Management' in the upper left corner of the Rancher Dashboard, and then select the desired cluster. On the cluster overview page, click on the kebab menu towards the right side and select 'View YAML'. The metadata.name is the cluster ID.
    Similarly for project ID, after selecting the cluster in 'Cluster Management', click the kebab menu on right of the project name and select 'View YAML'. The metadata.name is the project ID.
  5. [Optional] Toggle the Enable Member Synchronization switch if you wish to sync Rancher Project member roles into the platform's Project member roles.
  6. Save the changes to the project settings by pressing the button.
Disabling Rancher Integration

You may disable the Rancher integration at a per virtual cluster or per project level by toggling the same sliders used to enable it. Disabling the integration at the virtual cluster level simply removes it in Rancher. Disabling the integration at the project level removes all virtual clusters from Rancher, so be careful when disabling at this level!

Configuration Options​

kind required string ​

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion required string ​

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata required object ​

name required string ​

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

generateName required string ​

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

namespace required string ​

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid required string ​

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

resourceVersion required string ​

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

generation required integer ​

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

creationTimestamp required object ​

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionTimestamp required object ​

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds required integer ​

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

labels required object ​

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

annotations required object ​

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

ownerReferences required object[] ​

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

apiVersion required string ​

API version of the referent.

kind required string ​

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name required string ​

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

uid required string ​

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

controller required boolean false ​

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean false ​

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

finalizers required string[] ​

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

managedFields required object[] ​

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

manager required string ​

Manager is an identifier of the workflow managing these fields.

operation required string ​

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

apiVersion required string ​

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

time required object ​

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

fieldsType required string ​

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1 required object ​

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

subresource required string ​

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

spec required object ​

displayName required string ​

DisplayName is the name that should be displayed in the UI

description required string ​

Description describes an app

owner required object ​

Owner holds the owner of this object

user required string ​

User specifies a Loft user.

team required string ​

Team specifies a Loft team.

quotas required object ​

Quotas define the quotas inside the project

project required object ​

Project holds the quotas for the whole project

user required object ​

User holds the quotas per user / team

allowedClusters required object[] ​

AllowedClusters are target clusters that are allowed to target with environments.

name required string ​

Name is the name of the cluster that is allowed to create an environment in.

allowedRunners required object[] ​

AllowedRunners are target runners that are allowed to target with DevPod environments.

name required string ​

Name is the name of the runner that is allowed to create an environment in.

allowedTemplates required object[] ​

AllowedTemplates are the templates that are allowed to use in this project.

kind required string ​

Kind of the template that is allowed. Currently only supports DevPodWorkspaceTemplate, VirtualClusterTemplate & SpaceTemplate

group required string ​

Group of the template that is allowed. Currently only supports storage.loft.sh

name required string ​

Name of the template

isDefault required boolean false ​

IsDefault specifies if the template should be used as a default

requireTemplate required object ​

RequireTemplate configures if a template is required for instance creation.

disabled required boolean false ​

If true, all users within the project will be allowed to create a new instance without a template. By default, only admins are allowed to create a new instance without a template.

members required object[] ​

Members are the users and teams that are part of this project

kind required string ​

Kind is the kind of the member. Currently either User or Team

group required string ​

Group of the member. Currently only supports storage.loft.sh

name required string ​

Name of the member

clusterRole required string ​

ClusterRole is the assigned role for the above member

access required object[] ​

Access holds the access rights for users and teams

name required string ​

Name is an optional name that is used for this access rule

verbs required string[] ​

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

subresources required string[] ​

Subresources defines the sub resources that are allowed by this access rule

users required string[] ​

Users specifies which users should be able to access this secret with the aforementioned verbs

teams required string[] ​

Teams specifies which teams should be able to access this secret with the aforementioned verbs

namespacePattern required object ​

NamespacePattern specifies template patterns to use for creating each space or virtual cluster's namespace

space required string ​

Space holds the namespace pattern to use for space instances

virtualCluster required string ​

VirtualCluster holds the namespace pattern to use for virtual cluster instances

argoCD required object ​

ArgoIntegration holds information about ArgoCD Integration

enabled required boolean false ​

Enabled indicates if the ArgoCD Integration is enabled for the project -- this knob only enables the syncing of virtualclusters, but does not enable SSO integration or project creation (see subsequent spec sections!).

cluster required string ​

Cluster defines the name of the cluster that ArgoCD is deployed into -- if not provided this will default to 'loft-cluster'.

virtualClusterInstance required string ​

VirtualClusterInstance defines the name of virtual cluster (instance) that ArgoCD is deployed into. If provided, Cluster will be ignored and Loft will assume that ArgoCD is running in the specified virtual cluster.

namespace required string ​

Namespace defines the namespace in which ArgoCD is running in the cluster.

sso required object ​

SSO defines single-sign-on related values for the ArgoCD Integration. Enabling SSO will allow users to authenticate to ArgoCD via Loft.

enabled required boolean false ​

Enabled indicates if the ArgoCD SSO Integration is enabled for this project. Enabling this will cause Loft to configure SSO authentication via Loft in ArgoCD. If Projects are not enabled, all users associated with this Project will be assigned either the 'read-only' (default) role, or the roles set under the AssignedRoles field.

host required string ​

Host defines the ArgoCD host address that will be used for OIDC authentication between loft and ArgoCD. If not specified OIDC integration will be skipped, but vclusters/spaces will still be synced to ArgoCD.

assignedRoles required string[] ​

AssignedRoles is a list of roles to assign for users who authenticate via Loft -- by default this will be the read-only role. If any roles are provided this will override the default setting.

project required object ​

Project defines project related values for the ArgoCD Integration. Enabling Project integration will cause Loft to generate and manage an ArgoCD appProject that corresponds to the Loft Project.

enabled required boolean false ​

Enabled indicates if the ArgoCD Project Integration is enabled for this project. Enabling this will cause Loft to create an appProject in ArgoCD that is associated with the Loft Project. When Project integration is enabled Loft will override the default assigned role set in the SSO integration spec.

metadata required object ​

Metadata defines additional metadata to attach to the loft created project in ArgoCD.

extraAnnotations required object ​

ExtraAnnotations are optional annotations that can be attached to the project in ArgoCD.

extraLabels required object ​

ExtraLabels are optional labels that can be attached to the project in ArgoCD.

description required string ​

Description to add to the ArgoCD project.

sourceRepos required string[] ​

SourceRepos is a list of source repositories to attach/allow on the project, if not specified will be "*" indicating all source repositories.

roles required object[] ​

Roles is a list of roles that should be attached to the ArgoCD project. If roles are provided no loft default roles will be set. If no roles are provided and SSO is enabled, loft will configure sane default values.

name required string ​

Name of the ArgoCD role to attach to the project.

description required string ​

Description to add to the ArgoCD project.

rules required object[] ​

Rules ist a list of policy rules to attach to the role.

action required string ​

Action is one of "*", "get", "create", "update", "delete", "sync", or "override".

application required string ​

Application is the ArgoCD project/repository to apply the rule to.

permission required boolean false ​

Allow applies the "allow" permission to the rule, if allow is not set, the permission will always be set to "deny".

groups required string[] ​

Groups is a list of OIDC group names to bind to the role.

vault required object ​

VaultIntegration holds information about Vault Integration

enabled required boolean false ​

Enabled indicates if the Vault Integration is enabled for the project -- this knob only enables the syncing of secrets to or from Vault, but does not setup Kubernetes authentication methods or Kubernetes secrets engines for vclusters.

address required string ​

Address defines the address of the Vault instance to use for this project. Will default to the VAULT_ADDR environment variable if not provided.

skipTLSVerify required boolean false ​

SkipTLSVerify defines if TLS verification should be skipped when connecting to Vault.

namespace required string ​

Namespace defines the namespace to use when storing secrets in Vault.

auth required object ​

Auth defines the authentication method to use for this project.

token required string ​

Token defines the token to use for authentication.

tokenSecretRef required object ​

TokenSecretRef defines the Kubernetes secret to use for token authentication. Will be used if token is not provided.

Secret data should contain the token key.

name required string ​

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

key required string ​

The key of the secret to select from. Must be a valid secret key.

optional required boolean false ​

Specify whether the Secret or its key must be defined

syncInterval required string ​

SyncInterval defines the interval at which to sync secrets from Vault. Defaults to 1m. See https://pkg.go.dev/time#ParseDuration for supported formats.

rancher required object ​

RancherIntegration holds information about Rancher Integration

enabled required boolean false ​

Enabled indicates if the Rancher Project Integration is enabled for this project.

projectRef required object ​

ProjectRef defines references to rancher project, required for syncMembers and syncVirtualClusters.syncMembers

cluster required string ​

Cluster defines the Rancher cluster ID Needs to be the same id within Loft

project required string ​

Project defines the Rancher project ID

importVirtualClusters required object ​

ImportVirtualClusters defines settings to import virtual clusters to Rancher on creation

roleMapping required object ​

RoleMapping indicates an optional role mapping from a rancher project role to a rancher cluster role. Map to an empty role to exclude users and groups with that role from being synced.

syncMembers required object ​

SyncMembers defines settings to sync Rancher project members to the loft project

enabled required boolean true ​

Enabled indicates whether to sync rancher project members to the loft project.

roleMapping required object ​

RoleMapping indicates an optional role mapping from a rancher role to a loft role. Map to an empty role to exclude users and groups with that role from being synced.

status required object ​

quotas required object ​

Quotas holds the quota status

project required object ​

Project is the quota status for the whole project

limit required object ​

Limit is the amount limited, copied from spec.quotas.project

used required object ​

Used is the amount currently used across all clusters

clusters required object ​

Clusters holds the used amount per cluster. Maps cluster name to used resources

user required object ​

User is the quota status for each user / team. An example status could look like this: status: quotas: user: limit: pods: "10" spaces: "5" users: admin: used: spaces: "3" # (- calculated in our apiserver pods: "8" # (- the sum calculated from clusters clusters: cluster-1: # (- populated by agent from cluster-1 users: admin: pods: "3" cluster-2: users: admin: pods: "5"

limit required object ​

Limit is the amount limited per user / team

used required object ​

Used is the used amount per user / team

users required object ​

Users is a mapping of users to used resources

teams required object ​

Teams is a mapping of teams to used resources

clusters required object ​

Clusters holds the used amount per cluster. Maps cluster name to used resources

conditions required object ​

Conditions holds several conditions the project might be in