Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
richwats committed Jul 19, 2022
1 parent c7dda5c commit 43f3c00
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# terraform-aci-tenant-object
Terraform module to build a ACI Tenant in entirety from single HCL/JSON nested object variable file. This should simplify tenant configuration and allow for easier configuration changes and rollbacks.

This module also support re-using existing configuration through an optional `use_existing` parameter at most levels. This allows Terraform to manage child objects without fully managing the parent object (i.e. Terraform can add VRFs to the common tenant without disturbing existing configuration).
Please also see the related module [terraform-aci-fabric-object](https://github.com/cisco-apjc-cloud-se/terraform-aci-fabric-object) for building and managing physical ACI Fabric configuration (in entirety) from a single HCL/JSON/YAML object variable file.

This module supports re-using existing configuration through an optional `use_existing` parameter at most levels. This allows Terraform to manage child objects without fully managing the parent object (i.e. Terraform can add VRFs to the common tenant without disturbing existing configuration).

Where appropriate, the module will also allow re-using configuration from other tenants though this assumes the configuraiton is already present in that tenant (i.e. common filters or shared L3outs can be leveraged from the common tenant).

Expand All @@ -10,7 +12,7 @@ This module is used in the DevNet example ACI Day 2 Terraform Examples where the
Please see this link for examples of how this module is used.
[ACI Day 2 Automation with Terraform](https://github.com/cisco-apjc-cloud-se/aci-basic-day2)

The input variable object for this module is structured on the ACI Tenant tab (ACI 5.2+). The following configuration items are supported.
The input variable object for this module is structured on the ACI Tenant tab (ACI 5.2+). The following configuration items are supported:

- Applications Profiles (aps)
- End Point Groups (epgs)
Expand All @@ -35,6 +37,8 @@ The input variable object for this module is structured on the ACI Tenant tab (A
- Services
- L4-7 Policy Based Routing Support

For any additonal requests, please raise an enhancement request within the GitHub repository.

## Caveats
While care has been taken to reduce the number of cross-references, it may be possible to refer to an object that does not exist yet. Examples identified currently are:
- Creating L3Out External Endpoint Group(ExtEPGs) with Contract Master ExtEPG in the same tenant. It is possible that referenced ExtEPG maynot be created when the ExtEPG with the Control Master configuration is created. The only workaround for this is to ensure the Contract Master ExtEPG is created first by running the configuration plan twice.
Expand Down

0 comments on commit 43f3c00

Please sign in to comment.