Documentation

openshift_raw - Manage OpenShift objects

New in version 2.5.

Synopsis

  • Use the OpenShift Python client to perform CRUD operations on OpenShift objects.
  • Pass the object definition from a source file or inline. See examples for reading files and using Jinja templates.
  • Access to the full range of K8s and OpenShift APIs.
  • Authenticate using either a config file, certificates, password or token.
  • Supports check mode.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • openshift == 0.4.3
  • PyYAML >= 3.11

Parameters

Parameter Choices/Defaults Comments
api_key
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
api_version Default:
v1
Use to specify the API version. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with kind, name, and namespace to identify a specific object. If resource definition is provided, the apiVersion from the resource_definition will override this option.

aliases: api, version
cert_file
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
context
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
description
Use only when creating a project, otherwise ignored. Adds a description to the project metadata.
display_name
Use only when creating a project, otherwise ignored. Adds a display name to the project metadata.
force
    Choices:
  • no ←
  • yes
If set to True, and state is present, an existing object will be replaced.
host
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
key_file
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_HOST environment variable.
kind
Use to specify an object model. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with api_version, name, and namespace to identify a specific object. If resource definition is provided, the kind from the resource_definition will override this option.
kubeconfig
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
name
Use to specify an object name. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with api_version, kind and namespace to identify a specific object. If resource definition is provided, the metadata.name value from the resource_definition will override this option.
namespace
Use to specify an object namespace. Useful when creating, deleting, or discovering an object without providing a full resource definition. Use in conjunction with api_version, kind, and name to identify a specfic object. If resource definition is provided, the metadata.namespace value from the resource_definition will override this option.
password
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
resource_definition
Provide a valid YAML definition for an object when creating or updating. NOTE: kind, api_version, name, and namespace will be overwritten by corresponding values found in the provided resource_definition.

aliases: definition, inline
src
Provide a path to a file containing a valid YAML definition of an object to be created or updated. Mutually exclusive with resource_definition. NOTE: kind, api_version, name, and namespace will be overwritten by corresponding values found in the configuration read in from the src file.
Reads from the local file system. To read from the Ansible controller's file system, use the file lookup plugin or template lookup plugin, combined with the from_yaml filter, and pass the result to resource_definition. See Examples below.
ssl_ca_cert
Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
state
    Choices:
  • present ←
  • absent
Determines if an object should be created, patched, or deleted. When set to present, an object will be created, if it does not already exist. If set to absent, an existing object will be deleted. If set to present, an existing object will be patched, if its attributes differ from those specified using resource_definition or src.
username
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
verify_ssl
    Choices:
  • no
  • yes
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.

Notes

Note

Examples

- name: Create a project
  openshift_raw:
    api_version: v1
    kind: Project
    name: testing
    description: Testing
    display_name: "This is a test project."
    state: present

- name: Create a Persistent Volume Claim from an inline definition
  openshift_raw:
    state: present
    definition:
      apiVersion: v1
      kind: PersistentVolumeClaim
      metadata:
        name: elastic-volume
        namespace: testing
      spec:
        resources:
          requests:
            storage: 5Gi
        accessModes:
        - ReadWriteOnce

- name: Create a Deployment from an inline definition
  openshift_raw:
    state: present
    definition:
      apiVersion: v1
      kind: DeploymentConfig
      metadata:
        name: elastic
        labels:
          app: galaxy
          service: elastic
        namespace: testing
      spec:
        template:
          metadata:
            labels:
              app: galaxy
              service: elastic
          spec:
            containers:
              - name: elastic
                volumeMounts:
                - mountPath: /usr/share/elasticsearch/data
                  name: elastic-volume
                command: ["elasticsearch"]
                image: "ansible/galaxy-elasticsearch:2.4.6"
            volumes:
              - name: elastic-volume
                persistentVolumeClaim:
                  claimName: elastic-volume
          replicas: 1
          strategy:
            type: Rolling

- name: Remove an existing Deployment
  openshift_raw:
    api_version: v1
    kind: DeploymentConfig
    name: elastic
    namespace: testing
    state: absent

- name: Create a Secret
  openshift_raw:
    definition:
      apiVersion: v1
      kind: Secret
      metadata:
        name: mysecret
        namespace: testing
      type: Opaque
      data:
        username: "{{ 'admin' | b64encode }}"
        password: "{{ 'foobard' | b64encode }}"

- name: Retrieve a Secret
  openshift_raw:
    api: v1
    kind: Secret
    name: mysecret
    namespace: testing
  register: mysecret

# Passing the object definition from a file

- name: Create a Deployment by reading the definition from a local file
  openshift_raw:
    state: present
    src: /testing/deployment.yml

- name: Read definition file from the Ansible controller file system
  openshift_raw:
    state: present
    definition: "{{ lookup('file', '/testing/deployment.yml') | from_yaml }}"

- name: Read definition file from the Ansible controller file system after Jinja templating
  openshift_raw:
    state: present
    definition: "{{ lookup('template', '/testing/deployment.yml') | from_yaml }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
result
complex
success
The created, patched, or otherwise present object. Will be empty in the case of a deletion.

  status
complex
success
Current status details for the object.

  kind
str
success
Represents the REST resource this object represents.

  items
list
when resource is a List
Returned only when the kind is a List type resource. Contains a set of objects.

  spec
complex
success
Specific attributes of the object. Will vary based on the api_version and kind.

  api_version
str
success
The versioned schema of this representation of an object.

  metadata
complex
success
Standard object metadata. Includes name, namespace, annotations, labels, etc.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Chris Houseknecht (@chouseknecht)

Hint

If you notice any issues in this documentation you can edit this document to improve it.