Class: Ansible::Ruby::Modules::Kubernetes

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb

Overview

This module can manage Kubernetes resources on an existing cluster using the Kubernetes server API. Users can specify in-line API data, or specify an existing Kubernetes YAML file. Currently, this module (1) Only supports HTTP Basic Auth (2) Only supports ‘strategic merge’ for update, goo.gl/fCPYxT SSL certs are not working, use C(validate_certs=off) to disable.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_endpoint ⇒ String

Returns The IPv4 API endpoint of the Kubernetes cluster.

Returns:

  • (String) —

    The IPv4 API endpoint of the Kubernetes cluster.



13
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 13

attribute :api_endpoint

#certificate_authority_data ⇒ Object?

Returns Certificate Authority data for Kubernetes server. Should be in either standard PEM format or base64 encoded PEM data. Note that certificate verification is broken until ansible supports a version of ‘match_hostname’ that can match the IP address against the CA data.

Returns:

  • (Object, nil) —

    Certificate Authority data for Kubernetes server. Should be in either standard PEM format or base64 encoded PEM data. Note that certificate verification is broken until ansible supports a version of ‘match_hostname’ that can match the IP address against the CA data.



29
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 29

attribute :certificate_authority_data

#file_reference ⇒ String?

Returns Specify full path to a Kubernets YAML file to send to API I(endpoint). This option is mutually exclusive with C(‘inline_data’).

Returns:

  • (String, nil) —

    Specify full path to a Kubernets YAML file to send to API I(endpoint). This option is mutually exclusive with C(‘inline_data’).



21
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 21

attribute :file_reference

#inline_data ⇒ Hash

Returns The Kubernetes YAML data to send to the API I(endpoint). This option is mutually exclusive with C(‘file_reference’).

Returns:

  • (Hash) —

    The Kubernetes YAML data to send to the API I(endpoint). This option is mutually exclusive with C(‘file_reference’).



17
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 17

attribute :inline_data

#insecure ⇒ Boolean?

Returns Reverts the connection to using HTTP instead of HTTPS. This option should only be used when execuing the M(‘kubernetes’) module local to the Kubernetes cluster using the insecure local port (locahost:8080 by default).

Returns:

  • (Boolean, nil) —

    Reverts the connection to using HTTP instead of HTTPS. This option should only be used when execuing the M(‘kubernetes’) module local to the Kubernetes cluster using the insecure local port (locahost:8080 by default).



44
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 44

attribute :insecure

#patch_operation ⇒ :"JSON Patch", ...

Returns Specify patch operation for Kubernetes resource update.,For details, see the description of PATCH operations at U(github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/api-conventions.md#patch-operations).

Returns:



25
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 25

attribute :patch_operation

#state ⇒ :absent, ...

Returns The desired action to take on the Kubernetes data.

Returns:

  • (:absent, :present, :replace, :update) —

    The desired action to take on the Kubernetes data.



32
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 32

attribute :state

#url_password ⇒ String?

Returns The HTTP Basic Auth password for the API I(endpoint). This should be set unless using the C(‘insecure’) option.

Returns:

  • (String, nil) —

    The HTTP Basic Auth password for the API I(endpoint). This should be set unless using the C(‘insecure’) option.



36
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 36

attribute :url_password

#url_username ⇒ String?

Returns The HTTP Basic Auth username for the API I(endpoint). This should be set unless using the C(‘insecure’) option.

Returns:

  • (String, nil) —

    The HTTP Basic Auth username for the API I(endpoint). This should be set unless using the C(‘insecure’) option.



40
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 40

attribute :url_username

#validate_certs ⇒ :yes, ...

Returns Enable/disable certificate validation. Note that this is set to C(false) until Ansible can support IP address based certificate hostname matching (exists in >= python3.5.0).

Returns:

  • (:yes, :no, nil) —

    Enable/disable certificate validation. Note that this is set to C(false) until Ansible can support IP address based certificate hostname matching (exists in >= python3.5.0).



48
 
# File 'lib/ansible/ruby/modules/generated/clustering/k8s/kubernetes.rb', line 48

attribute :validate_certs