Unable to use DNS_ZONE or DNS_ZONE_ID env var

[ClevisonIBM]

Collection version

17.1.0

Environment information

ansible [core 2.16.4]
python version = 3.12.5
Package                                  Version
---------------------------------------- ------------
aiohappyeyeballs                         2.4.0
aiohttp                                  3.10.5
aiosignal                                1.3.1
alembic                                  1.13.2
ansible                                  9.3.0
ansible-core                             2.16.4
anyio                                    4.4.0
apache-airflow                           2.10.1
apache-airflow-providers-common-compat   1.2.0
apache-airflow-providers-common-io       1.4.0
apache-airflow-providers-common-sql      1.16.0
apache-airflow-providers-fab             1.3.0
apache-airflow-providers-ftp             3.11.0
apache-airflow-providers-http            4.13.0
apache-airflow-providers-imap            3.7.0
apache-airflow-providers-smtp            1.8.0
apache-airflow-providers-sqlite          3.9.0
apispec                                  6.6.1
argcomplete                              3.5.0
asgiref                                  3.8.1
attrs                                    24.2.0
babel                                    2.16.0
blinker                                  1.8.2
cachelib                                 0.9.0
cachetools                               5.3.3
certifi                                  2024.2.2
cffi                                     1.16.0
charset-normalizer                       3.3.2
click                                    8.1.7
clickclick                               20.10.2
colorama                                 0.4.6
colorlog                                 6.8.2
ConfigUpdater                            3.2
connexion                                2.14.2
cron-descriptor                          1.4.5
croniter                                 3.0.3
cryptography                             42.0.5
Deprecated                               1.2.14
dill                                     0.3.8
dnspython                                2.6.1
docutils                                 0.21.2
email_validator                          2.2.0
Flask                                    2.2.5
Flask-AppBuilder                         4.5.0
Flask-Babel                              2.0.0
Flask-Caching                            2.3.0
Flask-JWT-Extended                       4.6.0
Flask-Limiter                            3.8.0
Flask-Login                              0.6.3
Flask-Session                            0.5.0
Flask-SQLAlchemy                         2.5.1
Flask-WTF                                1.2.1
frozenlist                               1.4.1
fsspec                                   2024.9.0
google-auth                              2.28.2
google-re2                               1.1.20240702
googleapis-common-protos                 1.65.0
grpcio                                   1.66.1
gunicorn                                 23.0.0
h11                                      0.14.0
httpcore                                 1.0.5
httpx                                    0.27.2
ibm-cloud-networking-services            0.25.0
ibm-cloud-sdk-core                       3.20.6
idna                                     3.6
importlib_metadata                       8.4.0
importlib_resources                      6.4.5
inflection                               0.5.1
itsdangerous                             2.2.0
Jinja2                                   3.1.3
jmespath                                 1.0.1
jsonschema                               4.23.0
jsonschema-specifications                2023.12.1
junit-xml                                1.9
kafka-python                             2.0.3.dev0
kubernetes                               12.0.1
lazy-object-proxy                        1.10.0
limits                                   3.13.0
linkify-it-py                            2.0.3
lockfile                                 0.12.2
Mako                                     1.3.5
markdown-it-py                           3.0.0
MarkupSafe                               2.1.5
marshmallow                              3.22.0
marshmallow-oneofschema                  3.1.1
marshmallow-sqlalchemy                   0.28.2
mdit-py-plugins                          0.4.2
mdurl                                    0.1.2
methodtools                              0.4.7
more-itertools                           10.5.0
multidict                                6.1.0
oauthlib                                 3.2.2
openshift                                0.12.1
opentelemetry-api                        1.27.0
opentelemetry-exporter-otlp              1.27.0
opentelemetry-exporter-otlp-proto-common 1.27.0
opentelemetry-exporter-otlp-proto-grpc   1.27.0
opentelemetry-exporter-otlp-proto-http   1.27.0
opentelemetry-proto                      1.27.0
opentelemetry-sdk                        1.27.0
opentelemetry-semantic-conventions       0.48b0
ordered-set                              4.1.0
packaging                                24.0
pathspec                                 0.12.1
pendulum                                 3.0.0
pip                                      24.2
pluggy                                   1.5.0
prison                                   0.2.1
protobuf                                 4.25.4
psutil                                   6.0.0
pyasn1                                   0.5.1
pyasn1-modules                           0.3.0
pycparser                                2.21
Pygments                                 2.18.0
PyJWT                                    2.9.0
pymongo                                  4.6.2
python-daemon                            3.0.1
python-dateutil                          2.9.0.post0
python-nvd3                              0.16.0
python-slugify                           8.0.4
python-string-utils                      1.0.0
pytz                                     2024.1
PyYAML                                   6.0.1
referencing                              0.35.1
requests                                 2.31.0
requests-oauthlib                        1.4.0
requests-toolbelt                        1.0.0
resolvelib                               1.0.1
rfc3339-validator                        0.1.4
rich                                     13.8.1
rich-argparse                            1.5.2
rpds-py                                  0.20.0
rsa                                      4.9
ruamel.yaml                              0.18.6
ruamel.yaml.clib                         0.2.8
setproctitle                             1.3.3
setuptools                               69.2.0
six                                      1.16.0
sniffio                                  1.3.1
SQLAlchemy                               1.4.54
SQLAlchemy-JSONField                     1.0.2
SQLAlchemy-Utils                         0.41.2
sqlparse                                 0.5.1
tabulate                                 0.9.0
tenacity                                 9.0.0
termcolor                                2.4.0
text-unidecode                           1.3
time-machine                             2.15.0
typing_extensions                        4.12.2
tzdata                                   2024.1
uc-micro-py                              1.0.3
unicodecsv                               0.14.1
universal_pathlib                        0.2.5
urllib3                                  2.2.1
websocket-client                         1.7.0
Werkzeug                                 2.2.3
wheel                                    0.44.0
wirerope                                 0.4.7
wrapt                                    1.16.0
WTForms                                  3.1.2
xmljson                                  0.2.1
yarl                                     1.11.1
zipp                                     3.20.1

What happened?

When trying to run suite_dns role with CIS provider, if you have 2 or more domains on CIS the role will request you to add the DNS_ZONE_ID parameter to be able to know where the DNS entries should be deployed.

The issue is that the role source code doesn't get this from env var, even the cis_dns_entries.py file has code to handle it, but the variable expected on this script is DNS_ZONE and not DNS_ZONE_ID.

In addition to that IBM Cloud doesn't show that info anywhere, the IBM Cloud team told me that the correct name in CIS to reffer to this value should be DOMAIN ID.

Relevant log output

TASK [ibm.mas_devops.suite_dns : cis : run cis_dns_entries module (this can take several minutes)]

  "msg": "More than one zone found please choose one and export DNS_ZONE_ID env var."