From 8431137c1a09990d69bda4a2c2988241d9c884c6 Mon Sep 17 00:00:00 2001 From: lornasong Date: Mon, 29 Mar 2021 15:23:10 -0400 Subject: [PATCH] nia/docs 0.1.0 ga (#9946) * docs/nia: consul compatibilty * docs/nia: remove beta callouts (#9919) Co-authored-by: Kim Ngo <6362111+findkim@users.noreply.github.com> --- website/content/docs/nia/compatibility.mdx | 18 ++++++++++++++++++ website/content/docs/nia/index.mdx | 4 ++-- .../docs/nia/installation/requirements.mdx | 2 ++ website/content/docs/nia/terraform-modules.mdx | 2 -- .../docs/security/security-models/nia.mdx | 2 +- website/data/docs-navigation.js | 1 + 6 files changed, 24 insertions(+), 5 deletions(-) create mode 100644 website/content/docs/nia/compatibility.mdx diff --git a/website/content/docs/nia/compatibility.mdx b/website/content/docs/nia/compatibility.mdx new file mode 100644 index 0000000000..167d22404e --- /dev/null +++ b/website/content/docs/nia/compatibility.mdx @@ -0,0 +1,18 @@ +--- +layout: docs +page_title: Consul-Terraform-Sync Compatibility +sidebar_title: Compatibility +description: >- + Consul-Terraform-Sync Compatibility +--- +# Compatibility + +## Consul + +Below are the supported Consul versions with compatible Consul-Terraform-Sync versions. The latest Consul-Terraform-Sync binary targets supporting the latest patch version of the three most recent Consul minor versions. + +| Consul Version | Compatible Consul-Terraform-Sync Version | +| ------------------------------------ | ---------------------------------------- | +| Latest patch version of 1.9 | 0.1.0 | +| Latest patch version of 1.8 (1.8.9) | 0.1.0 | +| Latest patch version of 1.7 (1.7.13) | 0.1.0 | diff --git a/website/content/docs/nia/index.mdx b/website/content/docs/nia/index.mdx index 582854cf3b..05f0b53b53 100644 --- a/website/content/docs/nia/index.mdx +++ b/website/content/docs/nia/index.mdx @@ -1,12 +1,12 @@ --- layout: docs page_title: Network Infrastructure Automation -sidebar_title: Network Infrastructure Automation Beta +sidebar_title: Network Infrastructure Automation description: >- Network Infrastructure Automation (NIA) is the concept of dynamically updating infrastructure devices triggered by service changes. Consul-Terraform-Sync is a tool that performs NIA and utilizes Consul as a data source that contains networking information about services and monitors those services. Terraform is used as the underlying automation tool and leverages the Terraform provider ecosystem to drive relevant changes to the network infrastructure. --- -# Network Infrastructure Automation Beta +# Network Infrastructure Automation Network Infrastructure Automation (NIA) enables dynamic updates to network infrastructure devices triggered by service changes. Consul-Terraform-Sync utilizes Consul as a data source that contains networking information about services and monitors those services. Terraform is used as the underlying automation tool and leverages the Terraform provider ecosystem to drive relevant changes to the network infrastructure. diff --git a/website/content/docs/nia/installation/requirements.mdx b/website/content/docs/nia/installation/requirements.mdx index 2c78ba65f8..e938c5f897 100644 --- a/website/content/docs/nia/installation/requirements.mdx +++ b/website/content/docs/nia/installation/requirements.mdx @@ -20,6 +20,8 @@ Consul-Terraform-Sync is a daemon that runs alongside Consul, similar to other C To install a local Consul agent, refer to the [Getting Started: Install Consul Tutorial](https://learn.hashicorp.com/tutorials/consul/get-started-install). +For information on compatible Consul versions, refer to the [Consul compatibility matrix](/docs/nia/compatibility#consul). + ### Run an Agent The Consul agent must be running in order to dynamically update network devices. To run the local Consul agent, you can run Consul in development mode which can be started with `consul agent -dev` for simplicity. For more details on running Consul agent, refer to the [Getting Started: Run the Consul Agent Tutorial](https://learn.hashicorp.com/tutorials/consul/get-started-agent?in=consul/getting-started). diff --git a/website/content/docs/nia/terraform-modules.mdx b/website/content/docs/nia/terraform-modules.mdx index 388adcb011..8f6e4aa1ff 100644 --- a/website/content/docs/nia/terraform-modules.mdx +++ b/website/content/docs/nia/terraform-modules.mdx @@ -8,8 +8,6 @@ description: >- # Compatible Terraform Modules for Network Infrastructure Automation --> **Note:** Consul-Terraform-Sync is currently in Beta. Specifications in this section may change going into the General Availability release. - Consul-Terraform-Sync automates execution of Terraform modules through tasks. A task is a construct in Consul-Terraform-Sync that defines the automation of Terraform and the module. ## Module Specifications diff --git a/website/content/docs/security/security-models/nia.mdx b/website/content/docs/security/security-models/nia.mdx index cb4612040d..91ee1b9ad8 100644 --- a/website/content/docs/security/security-models/nia.mdx +++ b/website/content/docs/security/security-models/nia.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Consul NIA Security Model -sidebar_title: Network Infrastructure Automation Beta +sidebar_title: Network Infrastructure Automation description: >- Security model including requirements, recommendations, and threats for Consul Network Infrastructure Automation (NIA). --- diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 3f575073e3..b834fbaa1a 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -237,6 +237,7 @@ export default [ 'tasks', 'terraform-modules', 'network-drivers', + 'compatibility', ], },