fix(docs): Update all docs to state of 300dee2 (#181)

Updates all docs via autodoc to state of branch master on commit 300dee2. This allows Github action for mkdocs to build and publish the newest documentation pages. (This will then also include foreman_setting, foreman_katello_content_view and other new additions.) Signed-off-by: Dominik Pataky <[email protected]>
terraform-coop · Aug 12, 2024 · cfa6412 · cfa6412
1 parent 300dee2
commit cfa6412
Show file tree

Hide file tree

Showing 42 changed files with 378 additions and 86 deletions.
diff --git a/README.md b/README.md
@@ -127,7 +127,7 @@ To generate and view the entire repository and in-depth provider documentation:
 
 ```
 $> go build -v -o autodoc $(go list ./cmd/autodoc)
-$> mkdir -p docs/{datasources,resources}
+$> mkdir -p docs/{data-sources,resources}
 $> ./autodoc
 $> mkdocs serve
 INFO    -  Building documentation...

diff --git a/docs/data-sources/foreman_computeresource.md b/docs/data-sources/foreman_computeresource.md
@@ -1,28 +1,33 @@
+
 # foreman_computeresource
 
+
 Foreman representation of computeresource. ComputeResources serve as an identification string that defines autonomy, authority, or control for a portion of a network.
 
+
 ## Example Usage
 
-```hcl
+```
 # Autogenerated example with required keys
 data "foreman_computeresource" "example" {
 }
 ```
 
+
 ## Argument Reference
 
 The following arguments are supported:
 
 - `name` - (Required) The name of the compute resource.
 
+
 ## Attributes Reference
 
 The following attributes are exported:
 
 - `cachingenabled` - For VMware only
 - `datacenter` - For oVirt, VMware Datacenter
-- `description` - "Description of the compute resource",
+- `description` - Description of the compute resource
 - `displaytype` - For Libvirt: "VNC" or "SPICE". For VMWare: "VNC" or "VMRC"
 - `hypervisor` - The HyperVisor/Cloud Provider for this Compute Resource:supported providers include "Libvirt", "Ovirt", "EC2","Vmware", "Openstack", "Rackspace", "GCE"
 - `name` - The name of the compute resource.
@@ -31,3 +36,4 @@ The following attributes are exported:
 - `setconsolepassword` - For Libvirt and VMware only
 - `url` - URL for Libvirt, oVirt, OpenStack and Rackspace
 - `user` - Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2.
+
diff --git a/docs/data-sources/foreman_hostgroup.md b/docs/data-sources/foreman_hostgroup.md
@@ -28,6 +28,7 @@ The following attributes are exported:
 
 - `architecture_id` - ID of the architecture associated with this hostgroup.
 - `compute_profile_id` - ID of the compute profile associated with this hostgroup.
+- `compute_resource_id` - ID of the compute resource associated with this hostgroup.
 - `config_group_ids` - IDs of the applied config groups.
 - `content_source_id` - ID of the content source associated with this hostgroup.
 - `content_view_id` - ID of the content view associated with this hostgroup.

diff --git a/docs/data-sources/foreman_httpproxy.md b/docs/data-sources/foreman_httpproxy.md
diff --git a/docs/data-sources/foreman_image.md b/docs/data-sources/foreman_image.md
@@ -26,10 +26,11 @@ The following arguments are supported:
 
 The following attributes are exported:
 
-- `architecture_id` - 
+- `architecture_id` - ID of the architecture in Foreman
 - `compute_resource_id` - The id of the Compute Resource the image is associated with
 - `name` - The name of the compute resource.
-- `operating_system_id` - 
-- `username` - 
-- `uuid` - 
+- `operatingsystem_id` - ID of the operating system in Foreman
+- `user_data` - Does the image support user data (cloud-init etc.)?
+- `username` - Username used to log into the newly created machine that is based on this image
+- `uuid` - UUID of the image from the compute resource
 
diff --git a/docs/data-sources/foreman_jobtemplate.md b/docs/data-sources/foreman_jobtemplate.md
@@ -0,0 +1,38 @@
+
+# foreman_jobtemplate
+
+
+Foreman representation of a job template.
+
+
+## Example Usage
+
+```
+# Autogenerated example with required keys
+data "foreman_jobtemplate" "example" {
+  name = "change content sources"
+}
+```
+
+
+## Argument Reference
+
+The following arguments are supported:
+
+- `name` - (Required) job template name.
+
+
+## Attributes Reference
+
+The following attributes are exported:
+
+- `description` - 
+- `description_format` - 
+- `job_category` - 
+- `locked` - 
+- `name` - job template name.
+- `provider_type` - 
+- `snippet` - 
+- `template` - The template content itself
+- `template_inputs` - 
+
diff --git a/docs/data-sources/foreman_katello_content_credential.md b/docs/data-sources/foreman_katello_content_credential.md
diff --git a/docs/data-sources/foreman_katello_content_view.md b/docs/data-sources/foreman_katello_content_view.md
@@ -27,11 +27,13 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `auto_publish` - Relevant for Composite Content Views: 'Automatically publish a new version of the composite content view whenever one of its content views is published. Autopublish will only happen for component views that use the 'Always use latest version' option.'
-- `component_ids` - Relevant for CCVs: list of CV IDs.
+- `component_ids` - Relevant for CCVs: list of CV version IDs.
 - `composite` - Is this Content View a Composite CV?
 - `description` - Description for the (composite) content view
-- `filter` - Content view filters and their rules. Currently read-only, to be used as data source
+- `filter` - Content view filters and their rules.
+- `filtered` - 
 - `label` - Label for the (composite) content view. Cannot be changed after creation. By default set to the name, with underscores as spaces replacement.
+- `latest_version_id` - Holds the ID of the latest published version of a Content View to be used as reference in CCVs
 - `name` - Name of the content view.
 - `organization_id` - 
 - `repository_ids` - List of repository IDs.

diff --git a/docs/data-sources/foreman_katello_lifecycle_environment.md b/docs/data-sources/foreman_katello_lifecycle_environment.md
diff --git a/docs/data-sources/foreman_katello_product.md b/docs/data-sources/foreman_katello_product.md
@@ -28,7 +28,10 @@ The following attributes are exported:
 
 - `description` - Product description.
 - `gpg_key_id` - Identifier of the GPG key.
-- `label` - 
+- `label` - Label for the product. Cannot be changed after creation. By default set to the name, with underscores as spaces replacement.
 - `name` - Product name.
+- `ssl_ca_cert_id` - Idenifier of the SSL CA Cert.
+- `ssl_client_cert_id` - Identifier of the SSL Client Cert.
+- `ssl_client_key_id` - Identifier of the SSL Client Key.
 - `sync_plan_id` - Plan numeric identifier.
 
diff --git a/docs/data-sources/foreman_katello_repository.md b/docs/data-sources/foreman_katello_repository.md
@@ -28,27 +28,28 @@ The following attributes are exported:
 
 - `ansible_collection_requirements` - Contents of requirement yaml file to sync from URL.
 - `checksum_type` - Checksum of the repository, currently 'sha1' & 'sha256' are supported
-- `content_type` - Product the repository belongs to. Valid values include:`"deb"`, "docker"`, "file"`, "puppet"`, "yum"`.
+- `content_type` - Content type of the repository. Valid values include:`"deb"`, "docker"`, "file"`, "puppet"`, "yum"`, `"ansible_collection"`.
 - `deb_architectures` - Comma separated list of architectures to be synched from deb-archive.
 - `deb_components` - Comma separated list of repo components to be synched from deb-archive.
 - `deb_releases` - Comma separated list of releases to be synched from deb-archive.
 - `description` - Repository description.
 - `docker_tags_whitelist` - Comma separated list of tags to sync for Container Image repository.
 - `docker_upstream_name` - Name of the upstream docker repository
-- `download_concurrency` - Used to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10
+- `download_concurrency` - Used to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10. Warning: the value is not returned from the API and is therefore handled by a DiffSuppressFunc.
 - `download_policy` - Product the repository belongs to. Valid values include:`"immediate"`, "on_demand"`, "background"`.
 - `gpg_key_id` - Identifier of the GPG key.
 - `http_proxy_id` - ID of a HTTP Proxy.
 - `http_proxy_policy` - Policies for HTTP proxy for content sync. Valid values include:`"global_default_http_proxy"`, "none"`, "use_selected_http_proxy"`.
 - `ignorable_content` - List of content units to ignore while syncing a yum repository. Must be subset of rpm,drpm,srpm,distribution,erratum
 - `ignore_global_proxy` - If true, will ignore the globally configured proxy when syncing.
-- `label` - 
-- `mirror_on_sync` - true if this repository when synced has to be mirrored from the source and stale rpms removed.
+- `label` - Label of the repository. Cannot be changed after creation. Is auto generated from name if not specified.
+- `mirror_on_sync` - 'True' if this repository when synced has to be mirrored from the source and stale rpms removed.
+- `mirroring_policy` - Mirroring policy for this repo. Values: "mirror_content_only" or "additive".
 - `name` - Repository name.
 - `product_id` - Product the repository belongs to.
 - `unprotected` - true if this repository can be published via HTTP.
 - `upstream_password` - Password of the upstream repository user used for authentication.
 - `upstream_username` - Username of the upstream repository user used for authentication.
-- `url` - Repository source url.
+- `url` - Repository source URL or Docker registry URL
 - `verify_ssl_on_sync` - If true, Katello will verify the upstream url's SSL certifcates are signed by a trusted CA.
 
diff --git a/docs/data-sources/foreman_katello_sync_plan.md b/docs/data-sources/foreman_katello_sync_plan.md
@@ -31,5 +31,5 @@ The following attributes are exported:
 - `enabled` - Enables or disables synchronization.
 - `interval` - How often synchronization should run. Valid values include: `"hourly"`, `"daily"`, `"weekly"`,`"custom cron"`.
 - `name` - sync plan name.
-- `sync_date` - Start datetime of synchronization.
+- `sync_date` - Start datetime of synchronization. Use the specified format: YYYY-MM-DD HH:MM:SS +0000, where '+0000' is the timezone difference. A value of '+0000' means UTC.
 
diff --git a/docs/data-sources/foreman_partitiontable.md b/docs/data-sources/foreman_partitiontable.md
@@ -1,22 +1,27 @@
+
 # foreman_partitiontable
 
+
 The disk partition layout of the host.
 
+
 ## Example Usage
 
-```hcl
+```
 # Autogenerated example with required keys
 data "foreman_partitiontable" "example" {
   name = "Wayfair CentOS 7"
 }
 ```
 
+
 ## Argument Reference
 
 The following arguments are supported:
 
 - `name` - (Required) The name of the partition table.
 
+
 ## Attributes Reference
 
 The following attributes are exported:
@@ -31,3 +36,4 @@ The following attributes are exported:
 - `operatingsystem_ids` - IDs of the operating system associated with this partition table.
 - `os_family` - Operating system family. Values include: `"AIX"`, `"Altlinux"`, `"Archlinux"`, `"Coreos"`, `"Debian"`, `"Freebsd"`, `"Gentoo"`, `"Junos"`, `"NXOS"`, `"Redhat"`, `"Solaris"`, `"Suse"`, `"Windows"`.
 - `snippet` - Whether or not this partition table is a snippet to be embedded in other partition tables.
+
diff --git a/docs/data-sources/foreman_provisioningtemplate.md b/docs/data-sources/foreman_provisioningtemplate.md
@@ -1,44 +1,49 @@
+
 # foreman_provisioningtemplate
 
+
 Provisioning templates are scripts used to describe how to bootstrap and install the operating system on the host.
 
+
 ## Example Usage
 
-```hcl
+```
 # Autogenerated example with required keys
 data "foreman_provisioningtemplate" "example" {
   name = "ESXi 6.0 Kickstart - BO1"
 }
 ```
 
+
 ## Argument Reference
 
 The following arguments are supported:
 
 - `name` - (Required) The name of the provisioning template.
 
+
 ## Attributes Reference
 
 The following attributes are exported:
 
 - `audit_comment` - Notes and comments for auditing purposes.
-- `description` - Description of the provisioning template
+- `description` - A description of the provisioning template.
 - `locked` - Whether or not the template is locked for editing.
 - `name` - The name of the provisioning template.
 - `operatingsystem_ids` - IDs of the operating systems associated with this provisioning template.
 - `snippet` - Whether or not the provisioning template is a snippet be used by other templates.
 - `template` - The markup and code of the provisioning template.
 - `template_combinations_attributes` - How templates are determined:
 
-When editing a template, you must assign a list of operating systems which this template can be used with. Optionally, you can restrict a template to a list of host groups and/or environments.
+When editing a template, you must assign a list of operating systems which this template can be used with.  Optionally, you can restrict a template to a list of host groups and/or environments.
 
 When a host requests a template, Foreman will select the best match from the available templates of that type in the following order:
 
-1. host group and environment
-2. host group only
-3. environment only
-4. operating system default
+  1. host group and environment
+  2. host group only
+  3. environment only
+  4. operating system default
 
 Template combinations attributes contains an array of hostgroup IDs and environment ID combinations so they can be used in the provisioning template selection described above.
-
 - `template_kind_id` - ID of the template kind which categorizes the provisioning template. Optional for snippets, otherwise required.
+
diff --git a/docs/data-sources/foreman_puppetclass.md b/docs/data-sources/foreman_puppetclass.md
diff --git a/docs/data-sources/foreman_setting.md b/docs/data-sources/foreman_setting.md
@@ -0,0 +1,36 @@
+
+# foreman_setting
+
+
+Setting can be used to read settings from Foreman.
+
+
+## Example Usage
+
+```
+# Autogenerated example with required keys
+data "foreman_setting" "example" {
+  name = "foreman_url"
+}
+```
+
+
+## Argument Reference
+
+The following arguments are supported:
+
+- `name` - (Required) Name of the setting
+
+
+## Attributes Reference
+
+The following attributes are exported:
+
+- `category_name` - Name of the category the setting is in.
+- `default` - Default value of the setting
+- `description` - Description of the setting
+- `name` - Name of the setting
+- `readonly` - Indicates whether the setting is read-only or not.
+- `settings_type` - Data type of this setting (boolean, string, ..)
+- `value` - Value of the setting
+
diff --git a/docs/data-sources/foreman_smartclassparameter.md b/docs/data-sources/foreman_smartclassparameter.md
diff --git a/docs/data-sources/foreman_subnet.md b/docs/data-sources/foreman_subnet.md
@@ -1,24 +1,29 @@
+
 # foreman_subnet
 
+
 Foreman representation of a subnetwork.
 
+
 ## Example Usage
 
-```hcl
+```
 # Autogenerated example with required keys
 data "foreman_subnet" "example" {
   name = "public"
   network = "10.228.247.0"
 }
 ```
 
+
 ## Argument Reference
 
 The following arguments are supported:
 
 - `name` - (Optional) Name of a subnetwork.
 - `network` - (Optional) Subnet network.
 
+
 ## Attributes Reference
 
 The following attributes are exported:
@@ -37,10 +42,11 @@ The following attributes are exported:
 - `mask` - Netmask for this subnet.
 - `mtu` - MTU value for the subnet
 - `name` - Name of a subnetwork.
+- `network` - Subnet network.
 - `network_address` - The Subnets CIDR in the format 169.254.0.0/16
 - `network_type` - Type or protocol, IPv4 or IPv6, defaults to IPv4.
-- `network` - Subnet network.
 - `template_id` - Template HTTP(S) Proxy ID to use within this subnet
 - `tftp_id` - TFTP Proxy ID to use within this subnet
 - `to` - Ending IP address for IP auto suggestion.
 - `vlanid` - VLAN id that is in use in the subnet
+
diff --git a/docs/data-sources/foreman_templateinput.md b/docs/data-sources/foreman_templateinput.md
@@ -0,0 +1,42 @@
+
+# foreman_templateinput
+
+
+Foreman representation of a template input.
+
+
+## Example Usage
+
+```
+# Autogenerated example with required keys
+data "foreman_templateinput" "example" {
+}
+```
+
+
+## Argument Reference
+
+The following arguments are supported:
+
+
+
+## Attributes Reference
+
+The following attributes are exported:
+
+- `advanced` - 
+- `default` - 
+- `description` - 
+- `fact_name` - 
+- `hidden_value` - 
+- `id` - 
+- `input_type` - 
+- `name` - The name of the template input
+- `puppet_class_name` - 
+- `puppet_parameter_name` - 
+- `required` - 
+- `resource_type` - 
+- `template_id` - 
+- `value_type` - 
+- `variable_name` - 
+
diff --git a/docs/data-sources/foreman_user.md b/docs/data-sources/foreman_user.md
diff --git a/docs/data-sources/foreman_usergroup.md b/docs/data-sources/foreman_usergroup.md