Edit On Github

Kubernetes Plugin

---

With the Cloudify Kubernetes Plugin you can define Kubernetes resources in your blueprints.

Plugin Requirements

• Python versions:
  • 2.7.x
• Kubernetes Cluster see example cluster. GKE is also supported.

Compatibility

• Tested with Cloudify Premium 4.0.1 and Community Version 17.3.31
• Tested on Kubernetes 1.6.4, 1.7.5, 1.8.1, 1.8.3, 1.8.3-gke.0, 1.8.4.
• Tested with GKE.

Authentication

Authentication with the Kubernetes Plugin is via a node that represents the Kubernetes master. The config should be a Kube Config style object.

One of four methods options can be used to provide the configuration:

• Kubernetes config file contained by blueprint archive
• Kubernetes config file previously uploaded into Cloudify Manager VM
• Content of Kubernetes config file (YAML)

• Kubernetes API set o properties

• With GKE it is best to use legacy cluster certificate authentication. See here.

Example:

  kubernetes_master:
    type: cloudify.kubernetes.nodes.Master
    properties:
      configuration:
        apiVersion: v1
        kind: Config
        preferences: {}
        current-context: kubernetes-admin@kubernetes
        clusters:
        - name: kubernetes
          cluster:
            certificate-authority-data: { get_input: kubernetes_certificate_authority_data }
            server: { concat: [ 'https://', { get_input: kubernetes_master_ip}, ':', { get_input: kubernetes_master_port } ] }
        contexts:
        - name: kubernetes-admin@kubernetes
          context:
            cluster: kubernetes
            user: kubernetes-admin
        users:
        - name: kubernetes-admin
          user:
            client-certificate-data: { get_input: kubernetes-admin_client_certificate_data }
            client-key-data:  { get_input: kubernetes-admin_client_key_data }

When you deploy Kubernetes Cluster with Cloudify Simple Kubernetes Blueprint or Cloudify Kubernetes Provider, secrets containing the configuration are created.

Release History

The information in this documentation is current for Cloudify Kubernetes Plugin version 1.2.2.

See releases.

Example

This example demonstrates demonstrates a basic node template usage.

  my_application:
    type: cloudify.kubernetes.resources.MultipleFileDefinedResources
    properties:
      files:
        - resource_path: resources/my_app_service.yaml
        - resource_path: resources/my_app_pod.yaml
    relationships:
      - type: cloudify.kubernetes.relationships.managed_by_master
        target: master

  master:
    type: cloudify.kubernetes.nodes.Master
    properties:
      configuration:
        file_content: { get_input: kubernetes_configuration_file_content }

Many more examples are available here.

Types

cloudify.kubernetes.nodes.Master

This node represents an existing Kubernetes master.

Properties:

• configuration: A master config, one of the following:
  1. Kubernetes config file contained by blueprint archive
  2. Kubernetes config file previously uploaded into Cloudify Manager VM
  3. Content of Kubernetes config file (YAML)
  4. Kubernetes API set of properties

cloudify.kubernetes.resources.FileDefinedResource

This is a Kubernetes resource, such as a pod, service, deployment, which is defined in a file.

Properties:

• file: The path to the file relative to the blueprint.
• target_path: The path the file should be downloaded to. (Don’t use this.)
• template_variables If the file has Jinja template variable references, you may provide the variables as a dictionary here.

cloudify.kubernetes.resources.MultipleFileDefinedResources

Provide a list of files containing Kubernetes resources.

Properties:

• files a list of resource_path’s.

cloudify.kubernetes.resources.BlueprintDefinedResource

This is the root type of all Kubernetes resource, such as a pod, service, deployment, which is defined in the blueprint inline.

Properties:

• definition The resource definition. (The content of a Kubernetes template file.) This may be a string or JSON or YAML.
• options Kubernetes API mappings, such as { 'namespace': 'default' }.

Derived resource types:

Check the plugin.yaml for latest additions.

• cloudify.kubernetes.resources.Deployment
• cloudify.kubernetes.resources.Pod
• cloudify.kubernetes.resources.Service
• cloudify.kubernetes.resources.ReplicaSet
• cloudify.kubernetes.resources.ReplicationController
• cloudify.kubernetes.resources.PersistentVolume
• cloudify.kubernetes.resources.ConfigMap
• cloudify.kubernetes.resources.CustomBlueprintDefinedResource (See below).
• cloudify.kubernetes.resources.ReplicaSet
• cloudify.kubernetes.resources.ReplicaSet

cloudify.kubernetes.resources.CustomBlueprintDefinedResource

This allows you to define a resource type that is supported by the Kubernetes API, but has not yet been incorporated into the Kubneretes plugin.

Properties:

• definition The resource definition. (The content of a Kubernetes template file.) This may be a string or JSON or YAML.
• options Kubernetes API mappings, such as { 'namespace': 'default' }.
• api_mapping: The Kubernetes lifecycle mappings for create, read, and delete.

Example:

The plugin can be easily extended by referencing create, read, and delete api mappings for these supported APIs.

This is an example of a custom blueprint defined resource:

node_types:

  cloudify.kubernetes.resources.PersistentVolumeClaim:
    derived_from: cloudify.kubernetes.resources.CustomBlueprintDefinedResource
    properties:
      api_mapping:
        default:
          create:
            api: CoreV1Api
            method: create_namespaced_persistent_volume_claim
            payload: V1PersistentVolumeClaim
          read:
            api: CoreV1Api
            method: read_namespaced_persistent_volume_claim
          delete:
            api: CoreV1Api
            method: delete_namespaced_persistent_volume_claim
            payload: V1DeleteOptions

Further reading

The plugin is based on the Kubernetes Python Client library.