Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more detail to documentation (DCNE-121) #101

Open
codrake opened this issue Aug 18, 2020 · 2 comments
Open

Add more detail to documentation (DCNE-121) #101

codrake opened this issue Aug 18, 2020 · 2 comments
Labels
enhancement jira-sync Sync this issue to Jira

Comments

@codrake
Copy link

codrake commented Aug 18, 2020

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
Copy link
Contributor

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
Copy link

marinalf commented Dec 9, 2020

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: #134

@samiib samiib added the jira-sync Sync this issue to Jira label Aug 14, 2024
@github-actions github-actions bot changed the title Add more detail to documentation Add more detail to documentation (DCNE-121) Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement jira-sync Sync this issue to Jira
Projects
None yet
Development

No branches or pull requests

4 participants