Rancher2 API Library

This project provides access to a subset of the Rancher 2.x API in a highly opinionated fashion, intended primarily to address deployment concerns to Rancher2 and K8S within the @endeavorb2b stack.

Usage

This library can be included in your project to allow native access to the Rancher2 API methods via node-fetch. Fetch allows both backend and browser access to the API, but does not obscure credentials -- beware of this if building a browser application using this library.

All methods require at minimum a Rancher 2.x v3 API URL (such as https://cows.my-doma.in/api/v3) and a Rancher 2.x API key. While scoped keys are supported, this library assumes a hard dependancy of knowing the cluster ID at runtime. The Bearer Token format should be passed to the library methods (username:secretKey.)

Methods

• Cluster.list()
• Ingress.create()
• Ingress.list()
• Ingress.update()
• Namespace.create()
• Namespace.list()
• Project.create()
• Project.list()
• Service.create()
• Service.list()
• Workload.create()
• Workload.list()
• Workload.update()

Cluster

Supported: List.

cluster.list

Parameters: (uri, token)

Returns an array of cluster objects ({ id, name }).

Project

Supported: List and Create.

project.list

Parameters: ({ uri, token, clusterId })

Returns an array of project objects ({ id, name }).

project.create

Parameters: ({ uri, token, clusterId, name })

Creates and returns a project object ({ id, name }).

Service

Supported: List and Create.

service.list

Parameters: ({ uri, token, projectId })

Returns an array of service objects ({ id, name }).

service.create

Parameters: ({ uri, token, projectId, namespaceId, name, targetWorkloadIds })

Creates and returns a service object ({ id, name }).

Namespace

Supported: List and Create.

namespace.list

Parameters: ({ uri, token, clusterId }) Returns an array of namespace objects ({ id, name }).

namespace.create

Parameters: ({ uri, token, clusterId, projectId, name })

Creates and returns a namespace object ({ id, name }) within a project.

Workload

Supported: List, Create, and Update.

workload.list

Parameters: ({ uri, token, projectId })

Returns an array of workload objects ({ id, deploymentId, name }).

workload.create

Parameters: ({ uri, token, projectId, namespaceId, name, deploymentConfig, containers })

Creates and returns a workload object ({ id, deploymentId, name, ... }) within a project+namespace.

labels, if not specified, will default to the following:

{
  'workload.user.cattle.io/workloadselector': `deployment-${namespaceId}-${name}`
}

deploymentConfig, if not specified, will default to the following:

{
  maxSurge: 1,
  maxUnavailable: 0,
  minReadySeconds: 0,
  progressDeadlineSeconds: 600,
  revisionHistoryLimit: 10,
  strategy: 'RollingUpdate',
}

containers, if not specified or without a valid container definition, will default to the following:

[{
  env: [],
  image: 'busybox:latest',
  imagePullPolicy: 'IfNotPresent',
  name,
  entrypoint: ['top'],
  securityContext: {
    allowPrivilegeEscalation: false,
    capabilities: {},
    privileged: false,
    procMount: 'Default',
    readOnlyRootFilesystem: false,
    runAsNonRoot: false,
  },
  stdin: true,
  terminationMessagePath: '/dev/termination-log',
  terminationMessagePolicy: 'File',
  tty: true,
}]

cronJobConfig, if specified, should provide the following:

{
  concurrencyPolicy: 'Allow',
  failedJobsHistoryLimit: 10,
  schedule: '* * * * *', // A valid cron schedule
  successfulJobsHistoryLimit: 10,
  suspend: false,
}

workload.update

Parameters: ({ uri, token, projectId, workloadId, deploymentConfig, containers })

Updates and returns a workload object ({ id, deploymentId, name, ... }) within a project+namespace.

labels, if specified, MUST include the following:

{
  'workload.user.cattle.io/workloadselector': `deployment-${namespaceId}-${name}`
}

deploymentConfig, if not specified, will default to the following:

{
  maxSurge: 1,
  maxUnavailable: 0,
  minReadySeconds: 0,
  progressDeadlineSeconds: 600,
  revisionHistoryLimit: 10,
  strategy: 'RollingUpdate',
}

Ingress

Supported: List, Create, and Update.

ingress.list

Parameters: ({ uri, token, projectId })

Returns an array of ingress objects ({ id, name }).

ingress.create

Parameters: ({ uri, token, projectId, namespaceId, name, rules })

Creates and returns a ingress object ({ id, name, ... }) within a project+namespace.

rules must be an array of rule objects specifying the port and workloadIds. The URI path is optional:

{
  path: '/test2/test2',
  targetPort: 80,
  workloadIds: [ 'deployment:<namespaceId>:<workloadName>'],
}

ingress.update

Parameters: ({ uri, token, projectId, ingressId, rules })

Updates and returns a ingress object ({ id, name, ... }) within a project+namespace.

rules must be an array of rule objects specifying the port and workloadIds. The URI path is optional:

{
  path: '/test2/test2',
  targetPort: 80,
  workloadIds: [ 'deployment:<namespaceId>:<workloadName>'],
}

Contributing

Contributions are always welcome -- if you would like access to another module or would like to include support for some other feature of the Rancher2 API, please submit a pull request.

To get started, pull this repository and execute yarn && yarn start from the project root.

Resources

• Rancher 2.x API Documentation
• @endeavorb2b/rancher2cliA CLI implementation of this library, suitable for use via TravisCI or other CI/CD environs.