ansible / ansible.builtin / v2.9.4 / module / _openshift_scale Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. | "added in version" 2.5 of ansible.builtin" Authors: Chris Houseknecht (@chouseknecht), Fabian von Feilitzsch (@fabianvf) preview | supported by communityansible.builtin._openshift_scale (v2.9.4) — module
pip
Install with pip install ansible==2.9.4
Similar to the kubectl scale command. Use to set the number of replicas for a Deployment, ReplicaSet, or Replication Controller, or the parallelism attribute of a Job. Supports check mode.
- name: Scale deployment up, and extend timeout k8s_scale: api_version: v1 kind: Deployment name: elastic namespace: myproject replicas: 3 wait_timeout: 60
- name: Scale deployment down when current replicas match k8s_scale: api_version: v1 kind: Deployment name: elastic namespace: myproject current_replicas: 3 replicas: 2
- name: Increase job parallelism k8s_scale: api_version: batch/v1 kind: job name: pi-with-timeout namespace: testing replicas: 2
# Match object using local file or inline definition - name: Scale deployment based on a file from the local filesystem k8s_scale: src: /myproject/elastic_deployment.yml replicas: 3 wait: no
- name: Scale deployment based on a template output k8s_scale: resource_definition: "{{ lookup('template', '/myproject/elastic_deployment.yml') | from_yaml }}" replicas: 3 wait: no
- name: Scale deployment based on a file from the Ansible controller filesystem k8s_scale: resource_definition: "{{ lookup('file', '/myproject/elastic_deployment.yml') | from_yaml }}" replicas: 3 wait: no
src: description: - 'Provide a path to a file containing a valid YAML definition of an object or objects to be created or updated. Mutually exclusive with I(resource_definition). NOTE: I(kind), I(api_version), I(name), and I(namespace) will be overwritten by corresponding values found in the configuration read in from the I(src) file.' - Reads from the local file system. To read from the Ansible controller's file system, including vaulted files, use the file lookup plugin or template lookup plugin, combined with the from_yaml filter, and pass the result to I(resource_definition). See Examples below. - Mutually exclusive with I(template) in case of M(k8s) module. type: path host: description: - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. type: str kind: description: - Use to specify an object model. - Use to create, delete, or discover an object without providing a full resource definition. - Use in conjunction with I(api_version), I(name), and I(namespace) to identify a specific object. - If I(resource definition) is provided, the I(kind) value from the I(resource_definition) will override this option. type: str name: description: - Use to specify an object name. - Use to create, delete, or discover an object without providing a full resource definition. - Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a specific object. - If I(resource definition) is provided, the I(metadata.name) value from the I(resource_definition) will override this option. type: str wait: default: true description: - For Deployment, ReplicaSet, Replication Controller, wait for the status value of I(ready_replicas) to change to the number of I(replicas). In the case of a Job, this option is ignored. type: bool proxy: description: - The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable. - Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY). type: str api_key: description: - Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. type: str ca_cert: aliases: - ssl_ca_cert description: - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. type: path context: description: - The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. type: str password: description: - Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. - Please read the description of the C(username) option for a discussion of when this option is applicable. type: str replicas: description: - The desired number of replicas. required: true type: int username: description: - Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable. - Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the C(k8s_auth) module, as that might do what you need. type: str namespace: description: - Use to specify an object namespace. - Useful when creating, deleting, or discovering an object without providing a full resource definition. - Use in conjunction with I(api_version), I(kind), and I(name) to identify a specific object. - If I(resource definition) is provided, the I(metadata.namespace) value from the I(resource_definition) will override this option. type: str client_key: aliases: - key_file description: - Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. type: path kubeconfig: description: - 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 I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG environment variable. type: path api_version: aliases: - api - version default: v1 description: - Use to specify the API version. - Use to create, delete, or discover an object without providing a full resource definition. - Use in conjunction with I(kind), I(name), and I(namespace) to identify a specific object. - If I(resource definition) is provided, the I(apiVersion) value from the I(resource_definition) will override this option. type: str client_cert: aliases: - cert_file description: - Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. type: path wait_timeout: default: 20 description: - When C(wait) is I(True), the number of seconds to wait for the I(ready_replicas) status to equal I(replicas). If the status is not reached within the allotted time, an error will result. In the case of a Job, this option is ignored. type: int persist_config: description: - Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable. - When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file. - Default to false. - Please note that the current version of the k8s python client library does not support setting this flag to True yet. - 'The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169' type: bool validate_certs: aliases: - verify_ssl description: - Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. type: bool current_replicas: description: - For Deployment, ReplicaSet, Replication Controller, only scale, if the number of existing replicas matches. In the case of a Job, update parallelism only if the current parallelism value matches. type: int resource_version: description: - Only attempt to scale, if the current object version matches. type: str resource_definition: aliases: - definition - inline description: - Provide a valid YAML definition (either as a string, list, or dict) for an object when creating or updating. - 'NOTE: I(kind), I(api_version), I(name), and I(namespace) will be overwritten by corresponding values found in the provided I(resource_definition).'
result: contains: api_version: description: The versioned schema of this representation of an object. returned: success type: str kind: description: Represents the REST resource this object represents. returned: success type: str metadata: description: Standard object metadata. Includes name, namespace, annotations, labels, etc. returned: success type: complex spec: description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind). returned: success type: complex status: description: Current status details for the object. returned: success type: complex description: - If a change was made, will return the patched object, otherwise returns the existing object. returned: success type: complex