NGINX Controller License

This repository has been archived. There will likely be no further development on the project and security vulnerabilities may be unaddressed.

A role to push an NGINX Controller license to your NGINX Controller platform.

Requirements

• NGINX Controller
• NGINX Controller license file

Role Variables

-- All the below variables are required --

nginx_controller_license - A base64 encoded string of your NGINX Controller license file. Has to be one line, with no line endings or carriage returns. The below example uses the b64encode filter to do this encoding.

nginx_controller_fqdn - The FQDN / hostname of your Controller server.

nginx_controller_auth_token - Authentication token for NGINX Controller. You can use the nginxinc.nginx_controller_license role to set this variable.

Dependencies

none

Example Playbook

To use this role you can create a playbook such as the following:

- hosts: localhost
  gather_facts: no

  vars:
    nginx_controller_user_email: "user@example.com"
    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_license

    - name: Push the NGINX Controller license to your instance
      include_role:
        name: nginxinc.nginx_controller_license
      vars:
        # controller.auth_token: output by previous role in example
        nginx_controller_license: "{{ lookup('file', 'license/controller_license.txt') | b64encode }}"

You can then run ansible-playbook nginx_controller_license.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_license.yaml -e "nginx_controller_user_email=user@company.com 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_component.yaml -e "@nginx_controller_license_vars.yaml"

License

Apache License, Version 2.0

Author Information

Brian Ehlert

Alessandro Fael Garcia

Daniel Edgar

© NGINX, Inc. 2020