k8s_scale – Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# k8s_scale – Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job

New in version 2.5.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- 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.

Aliases: openshift_scale

## Requirements

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

- python >= 2.7
- openshift >= 0.6
- PyYAML >= 3.11

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
api_key string |  | Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
api_version string | 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
ca_cert path |  | 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. aliases: ssl_ca_cert
client_cert path |  | Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. aliases: cert_file
client_key path |  | Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. aliases: key_file
context string |  | The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
current_replicas integer |  | 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.
host string |  | Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
kind string |  | 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 |  | 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 string |  | 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 string |  | 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 string |  | Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. Please read the description of the `username` option for a discussion of when this option is applicable.
proxy - added in 2.9 |  | 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).
replicas integer |  | The desired number of replicas.
resource_definition - |  | Provide a valid YAML definition (either as a string, list, or dict) 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
resource_version string |  | Only attempt to scale, if the current object version matches.
src path |  | Provide a path to a file containing a valid YAML definition of an object or objects 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, including vaulted files, 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.
username string |  | 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 `k8s_auth` module, as that might do what you need.
validate_certs boolean | 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. aliases: verify_ssl
wait boolean | Choices: no yes ← | For Deployment, ReplicaSet, Replication Controller, wait for the status value of ready_replicas to change to the number of replicas. In the case of a Job, this option is ignored.
wait_timeout integer | Default: 20 | When `wait` is True, the number of seconds to wait for the ready_replicas status to equal 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.

## Notes

Note

- The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python
- To avoid SSL certificate validation errors when `validate_certs` is True, the full certificate chain for the API server must be provided via `ca_cert` or in the kubeconfig file.

## Examples

    - 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

## Return Values

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

Key | Returned | Description
--- | --- | ---
result complex | success | If a change was made, will return the patched object, otherwise returns the existing object.
| api_version string | success | The versioned schema of this representation of an object.
| kind string | success | Represents the REST resource this object represents.
| metadata complex | success | Standard object metadata. Includes name, namespace, annotations, labels, etc.
| spec complex | success | Specific attributes of the object. Will vary based on the api_version and kind.
| status complex | success | Current status details for the object.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Chris Houseknecht (@chouseknecht)
- Fabian von Feilitzsch (@fabianvf)

Hint

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