This repository has been archived. There will likely be no further development on the project and security vulnerabilities may be unaddressed.
Upsert (create and update) Open API 3 definitions to NGINX Controller for use as Published APIs.
nginx_controller.fqdn - The hostname or DNS of the NGINX Controller instance.
nginx_controller.auth_token - An authentication token for the NGINX Controller API (the nginx_controller_generate_token role outputs this).
nginx_controller_api_definition_name - the name given to the API definition in Controller
nginx_controller_api_definition_version - the version string: "v1", "v2.5.6", "george"
nginx_controller_api_definition - the body of the Open API definition
This role has multiple template related variables. The descriptions and defaults for all these variables can be found in vars/main.yml
To use this role you can create a playbook such as the following (let's name it nginx_controller_certificate.yaml for the purposes of this example).
- hosts: localhost
gather_facts: no
vars:
nginx_controller_user_email: "[email protected]"
nginx_controller_user_password: "mySecurePassword"
nginx_controller_fqdn: "controller.mydomain.com"
nginx_controller_validate_certs: false
tasks:
- name: Retrieve the NGINX Controller auth token
include_role:
name: nginxinc.nginx_controller_generate_token
- name: Import the API definition
include_role:
name: nginxinc.nginx_controller_api_definition_import
vars:
nginx_controller_api_definition_version: "v1"
nginx_controller_api_definition_name: "f1-api"
nginx_controller_api_definition: <yaml body>You can then run ansible-playbook nginx_controller_api_definition_import.yaml to execute the playbook.
Alternatively, you can also pass/override any variables at run time using the --extra-vars or -e flag like so ansible-playbook nginx_controller_api_definition_import.yaml -e "[email protected] nginx_controller_user_password=notsecure nginx_controller_fqdn=controller.example.local nginx_controller_validate_certs=false"
You can also pass/override any variables by passing a yaml file containing any number of variables like so ansible-playbook nginx_controller_api_definition_import.yaml -e "@nginx_controller_api_definition_import_vars.yaml"
© NGINX, Inc. 2020