From 39183d1b76e276e90bcab52e9a8ea198eab3f5b3 Mon Sep 17 00:00:00 2001 From: Artis3n Date: Sat, 5 Sep 2020 18:29:52 -0400 Subject: [PATCH] Updated documentation with `make generate` --- provisioner/ansible/provisioner.hcl2spec.go | 2 ++ .../provisioner/ansible/Config-not-required.mdx | 13 +++++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/provisioner/ansible/provisioner.hcl2spec.go b/provisioner/ansible/provisioner.hcl2spec.go index 91b7fce71..61217c677 100644 --- a/provisioner/ansible/provisioner.hcl2spec.go +++ b/provisioner/ansible/provisioner.hcl2spec.go @@ -39,6 +39,7 @@ type FlatConfig struct { GalaxyCommand *string `mapstructure:"galaxy_command" cty:"galaxy_command" hcl:"galaxy_command"` GalaxyForceInstall *bool `mapstructure:"galaxy_force_install" cty:"galaxy_force_install" hcl:"galaxy_force_install"` RolesPath *string `mapstructure:"roles_path" cty:"roles_path" hcl:"roles_path"` + CollectionsPath *string `mapstructure:"collections_path" cty:"collections_path" hcl:"collections_path"` UseProxy *bool `mapstructure:"use_proxy" cty:"use_proxy" hcl:"use_proxy"` } @@ -84,6 +85,7 @@ func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec { "galaxy_command": &hcldec.AttrSpec{Name: "galaxy_command", Type: cty.String, Required: false}, "galaxy_force_install": &hcldec.AttrSpec{Name: "galaxy_force_install", Type: cty.Bool, Required: false}, "roles_path": &hcldec.AttrSpec{Name: "roles_path", Type: cty.String, Required: false}, + "collections_path": &hcldec.AttrSpec{Name: "collections_path", Type: cty.String, Required: false}, "use_proxy": &hcldec.AttrSpec{Name: "use_proxy", Type: cty.Bool, Required: false}, } return s diff --git a/website/pages/partials/provisioner/ansible/Config-not-required.mdx b/website/pages/partials/provisioner/ansible/Config-not-required.mdx index 751649e99..99d0df0f5 100644 --- a/website/pages/partials/provisioner/ansible/Config-not-required.mdx +++ b/website/pages/partials/provisioner/ansible/Config-not-required.mdx @@ -120,8 +120,8 @@ test your playbook. this option is not used if you set an `inventory_file`. - `galaxy_file` (string) - A requirements file which provides a way to - install roles with the [ansible-galaxy - cli](http://docs.ansible.com/ansible/galaxy.html#the-ansible-galaxy-command-line-tool) + install roles or collections with the [ansible-galaxy + cli](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#the-ansible-galaxy-command-line-tool) on the local machine before executing `ansible-playbook`. By default, this is empty. - `galaxy_command` (string) - The command to invoke ansible-galaxy. By default, this is @@ -131,11 +131,16 @@ Adds `--force` option to `ansible-galaxy` command. By default, this is `false`. -- `roles_path` (string) - The path to the directory on your local system to - install the roles in. Adds `--roles-path /path/to/your/roles` to +- `roles_path` (string) - The path to the directory on your local system in which to + install the roles. Adds `--roles-path /path/to/your/roles` to `ansible-galaxy` command. By default, this is empty, and thus `--roles-path` option is not added to the command. +- `collections_path` (string) - The path to the directory on your local system in which to + install the collections. Adds `--collections-path /path/to/your/collections` to + `ansible-galaxy` command. By default, this is empty, and thus `--collections-path` + option is not added to the command. + - `use_proxy` (boolean) - When `true`, set up a localhost proxy adapter so that Ansible has an IP address to connect to, even if your guest does not have an IP address. For example, the adapter is necessary for Docker builds