Skip to content

deployimage#

Collection Note

This module is part of the nokia.eda_os_v1alpha1 collection. To install the collection, use:

ansible-galaxy collection install nokia.eda_os_v1alpha1
Added in version 0.3.0.

Synopsis#

  • Upgrade / downgrade images on targets. This workflow can be used directly on a target or list of targets, or with selectors to select targets through labels. It also supports tranches, which are groups of targets that can be upgraded together. By default a set of checks are run before and after the image change, but this can be controlled via the checks field. It also supports canaries, which are upgraded before any other targets.

Parameters#

Parameter Defaults / Choices Comments
auth_token
str
required
HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN".
Required unless state is cronly.
base_url
str
required
EDA API URL including the schema and port (if non standard for the provided schema). Example - https://try.eda.demo:9443.
Required unless state is cronly.
ca_path
str
required
A path to the PEM-encoded CA certificate to use for TLS verification.
Required unless state is cronly.
name
str
required
Name of the DeployImage.
Required when state is query or absent.
namespace
str
required
The namespace to use when querying or removing the resource.
Required when state is query or absent.
resource
dict
required
The DeployImage resource definition in YAML format as seen in the EDA UI or https://crd.eda.dev.
Required when state is present or cronly.
state
str
required
Choices: absent, query, present, cronly State of the requested resource object.
tls_skip_verify
bool
required
A flag to control the TLS verification of the session.
Required unless state is cronly.

Authors#