Updated documentation with `make generate`
This commit is contained in:
parent
9a2908d1d9
commit
39183d1b76
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue