Add more detail to documentation (DCNE-121)

codrake commented 4 years ago

Community Note

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Provide more detailed documentation to show options that arguments can accept, defaults for those arguments, type, relation/impact on other arguments, explanation of what the argument/options do, etc. Would also be helpful to show some additional resource usage examples utilizing various argument combinations for common use cases.

New or Affected Resource(s) + ACI Class(es):

Applies to all resources and data providers

APIC version and APIC Platform

NA

Potential Terraform Configuration

For each Argument listed in Argument Reference
- List accepted choices, required or not, choice type (string, int, Boolean), and what the default value is (if appropriate)
- Provide text/comments/explanation on what the Argument is for and what feature it controls and explanation of what the choices (if any) set/control and any interaction with other arguments
For each Resource, provide multiple usage examples that would utilize some combination of acceptable arguments

For example, using the aci_epg_to_domain resource:

Argument options example:

Instr_imedcy - string (optional)

Determines when the policy is pushed to hardware Policy CAM. The APIC defaults to lazy when unset during creation.

Options are: immediate or lazy

encap_mode - string (optional)

The encapsulation method to be used. The APIC defaults to auto when unset during creation. If vxlan is selected, switching_mode must be AVE.

Options are: auto, vlan, vxlan

nkatarmal-crest commented 4 years ago

This issue has been fixed in the version 0.5.0 of the provider. Please try that and let me know if we can close this issue or not.

marinalf commented 3 years ago

A request to add more clarity on how to enable TGW in AWS for those cases where the hub network name is already defined as part of the initial setup. The example has "gwrouterp-default" and it could be "gwrouterp-[name of existing hub network] which could be direct or through var.

source: https://github.com/CiscoDevNet/terraform-provider-aci/issues/134

CiscoDevNet / terraform-provider-aci