Commit Graph

244 Commits

Author SHA1 Message Date
Usha Kodali 922004d46b
Consul on ECS compatibility matrix docs update (#13060) 2022-07-06 12:34:14 -07:00
Jared Kirschner 93edefd4a1 docs: improve large version change upgrade path 2022-07-01 05:47:24 -07:00
Tu Nguyen a35d37c574
Merge pull request #13433 from hashicorp/docs-cluster-peering-technical-preview
docs: Cluster Peering for OSS Technical Preview
2022-06-22 00:10:11 -07:00
Jeff Apple 4895c5f8b9
Merge pull request #13427 from hashicorp/docs/capigw-0.3
docs: Update docs for release of Consul API Gateway v0.3.0
2022-06-22 00:00:42 -07:00
David Yu 4c0b4d026c
docs: move k8s compat matrix top level (#13534) 2022-06-21 14:43:10 -07:00
Tu Nguyen 23e4884779
Merge pull request #13448 from hashicorp/docs-cluster-peering-k8s-technical-preview
docs: Cluster Peering for Kubernetes Technical Preview
2022-06-21 10:18:13 -07:00
Jeff-Apple 8aee4fecb5 API GW 0.3 Release Notes and updated Tech Specs 2022-06-20 17:00:11 -07:00
John Murret 6b77fa11d9
Docs - k8s - Webhook Certs on Vault (#13441)
* Docs - k8s - Webhook Certs on Vault

* Adding webhook certs to data-integration overview page

* marking items as code

* Apply suggestions from code review

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Updating prerequisites intro

* Updating prerequisites intro

* Updating `Create a Vault auth roles that link the policy to each Consul on Kubernetes service account that requires access` to `Link the Vault policy to Consul workloads`

* changing `Configure the Vault Kubernetes auth role in the Consul on Kubernetes helm chart` to `Update the Consul on Kubernetes helm chart`.

* Changed `Create a Vault PKI role that establishes the domains that it is allowed to issue certificates for` to `Configure allowed domains for PKI certificates`

* Moved `Create a Vault policy that authorizes the desired level of access to the secret` to the Set up per Consul Datacenter section

* Update website/content/docs/k8s/installation/vault/data-integration/webhook-certs.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Moving Overview above Prerequisites.  Adding sentence where missing after page title.

* Moving Overview above Prerequisites for webhook certs page.

* fixing the end of the overview section that was not moved.

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-06-17 10:23:54 -06:00
Freddy 082bc3632b
Add peering endpoint API docs (#13454) 2022-06-15 14:18:14 -06:00
Jeff Boruszak 3b85a9dda2
Update website/data/docs-nav-data.json
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-06-15 14:26:54 -05:00
Eric Haberkorn eb9c341f5e
Lambda Beta Documentation (#13426)
* Document the `enable_serverless_plugin` Agent Configuration Option (#13372)
* Initial AWS Lambda documentation (#13245)
2022-06-15 11:14:16 -04:00
boruszak 72b91c3481 Nav.json updates 2022-06-14 17:14:34 -05:00
boruszak 703ce412c7 Removing k8s updates on this branch 2022-06-14 17:12:45 -05:00
boruszak b9a4ff73ce Updated nav.json 2022-06-14 17:01:48 -05:00
Jeff Boruszak 3097f4d00f
Added nav data 2022-06-13 17:27:11 -05:00
Michael Wilkerson bccd920db7
Nia/docs 0.6.0 (#13107)
* updated docs
- added docs for start command
- deprecated running without a command
- added instructions for autocomplete setup

* addressed review comments

* addressed review comments

* addressed review comments

* docs/nia: Terraform Cloud agent support

- Add agent as a supported execution mode
- Add terraform_cloud_workspace configuration
- Deprecate existing terraform_version config

* license block docs

* added HCP Consul to compatibility

* added HCP instructions

* addressed review comments

* added new auto-retrieval behavior to license docs

* addressed review comments

* addressed review comments

* Apply suggestions from code review

* Apply suggestions from code review

* updated docs

* updated docs

* Apply suggestions from code review

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* fixed heading types

* fixed heading types

* update docs

* docs/nia: Add service registration configurations

* docs/nia: Style guide updates

* docs/nia: Update with beta docs feedback

* docs/nia: Update license config formatting

Other top-level blocks aren't included in the list of global config options,
so removed the liciense entry.

* docs/nia: Add auto-retrieval section to license page

* docs/nia: Separate column for HCP Consul support

* docs/nia: Compatiblity version upper bounds

* docs/nia: Fix broken links

* docs/nia: Style guide fixes

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* Remove RequestId field from cts health api docs.

* docs/nia - Update CTS service id format (#13125)

* docs/nia: Convert Consul config to table format

* docs/nia: Add ACL token policy requirements

* update docs (#13174)

* docs/nia: Fix ca_path, key default, and some links

* docs/nia: Add CTS service address config

* Update website/content/docs/nia/cli/index.mdx

* docs/nia: update for 0.6 GA (#13191)



Co-authored-by: devarshishah3 <devarshishah3@gmail.com>
Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

Co-authored-by: Melissa Kam <mkam@hashicorp.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: Derek Menteer <derek.menteer@hashicorp.com>
Co-authored-by: lornasong <lornasong@users.noreply.github.com>
Co-authored-by: hashi-derek <105233703+hashi-derek@users.noreply.github.com>
Co-authored-by: devarshishah3 <devarshishah3@gmail.com>
2022-05-25 14:23:43 -04:00
Michael Wilkerson 3a196db8de
Beta CTS Docs (#12916)
* updated beta docs

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: AJ Jwair <aj.jwair@hashicorp.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* updated beta docs

* updated beta docs

* updated beta docs

* updated docs

* updated docs

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* update docs

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* docs/nia: Health endpoint and service registration

- Add Health endpoint docs
- Add CTS service registration docs

* update docs

* docs/nia: Miscellaneous fixes to beta docs

Co-authored-by: lornasong <lornasong@users.noreply.github.com>

* docs/nia: Update TFC agents description

Co-authored-by: AJ Jwair <aj.jwair@hashicorp.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: lornasong <lornasong@users.noreply.github.com>
Co-authored-by: Melissa Kam <mkam@hashicorp.com>
2022-05-11 15:53:49 -07:00
Jared Kirschner 2ab5559a6a docs: add guidance on improving Consul resilience
Discuss available strategies for improving server-level and infrastructure-level
fault tolerance in Consul.
2022-04-29 10:58:03 -07:00
Jeff-Apple 14030b261e Adding release notes for API Gateway v0.2 2022-04-27 11:44:39 -07:00
trujillo-adam ef0e29f350 edits to draft of upgrades 2022-04-27 11:03:14 -07:00
Sarah Alsmiller 841dbf51dd add upgrade path documentation 2022-04-27 10:13:40 -04:00
Jeff Apple 238de66109
Merge pull request #12858 from hashicorp/japple-rel-notes-reorg
Reorganization of the Release Notes on Consul.io
2022-04-26 13:29:26 -07:00
Jeff Apple 7f4e9c57cc
Merge branch 'main' into japple-rel-notes-reorg 2022-04-25 21:33:50 -07:00
Jeff-Apple a37615318d Docs: Release Notes reorg - adding ECS and NIA 2022-04-25 20:59:18 -07:00
Karl Cardenas 7ead9840b5
docs: updated connect docs and re-deploying missed changes 2022-04-25 10:04:06 -07:00
Jeff-Apple d4a0fcc108 Adding Rel Notes for ECS and moved CTS one. 2022-04-22 12:15:09 -07:00
John Murret 2b8f10feec
Adding documentation for WAN Federation with Vault as a secrets backend (#12802)
* Adding documentation for WAN Federation with Vault as a secrets backend

* Reformatting systems integration

* fixing spacing and typos

* Fixing link to createFederactionSecret helm chart value

* More revisions in the Systems Integration section

* Systems Integration - fixing brok shell-session and adding paragraph.

* More formatting in data integration section

* Formatting consul config sections

* Fixing verbiage near helm installations.

* Changing refence to dc1 and dc2 to be primary datacenter(dc1) and secondary dataceneter (dc2)

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
Co-authored-by: David Yu <dyu@hashicorp.com>

* fixing missing s in Kubernetes

* Providing reason in Usage section as to why someone would look at the Systems and Data Integration sections of the vault docs

* fixing highlighted linenumbers that got through off by deleting the comment line at the beginning.

* fixing indentation within order lists

* Add a validation step to the next steps section.

* making the data integration sections for dc1 and dc2 symmetrical

* PR Feedback

* Adding images

* Remove confusing references to Systems Integration and Data Integration pages.

* Updating images to be centered

* Removed confusing reference to federation secret.

Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
Co-authored-by: David Yu <dyu@hashicorp.com>
2022-04-21 11:07:04 -06:00
Bryce Kalow 9a61976a38
website: remove source code (#12806) 2022-04-19 12:32:02 -05:00
Paul Glass bbb13b026c
Docs: IAM auth method (#12779)
* Docs: IAM auth method

Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
2022-04-18 14:34:37 -05:00
Jeff-Apple 521579724e Rename and re-title docs page for installing Consul API Gateway 2022-04-17 20:41:29 -07:00
Jeff-Apple b58f673039 Initial changes for reoranizing the Release Notes 2022-04-17 16:57:32 -07:00
FFMMM edfbbf1063
Update latest version on website to 1.11.5
Per the latest release
2022-04-13 17:38:31 -07:00
Natalie Smith b9ec2222db docs: simplify agent docs slugs 2022-04-11 17:38:47 -07:00
Blake Covarrubias f7edcdc6b9 docs: move agent/options.mdx into agent/config/index.mdx and add placeholder .mdx files for cli/files
Also update nav data
2022-04-11 16:05:21 -07:00
John Murret 2f7a30b393
Update k8s docs for Vault as a Secrets Backend (#12691)
* Updating k8s Vault as a Secrets Backend docs

* Moving files in data-integration folder

* Updating routes to moved files

* Removing known limitations since we have delivered them.

* Revise overview page to point towards the System Integration and Data Integration pages.

* Updating Systems Overview page

* Making corrections to Overview and Systems Integration page

* Updating Data Integration page

* Gossip page

* Enterprise Licensepage

* Bootstrap Token

* Replication Token

* Revisions to bootrap, replication, and enterprise license

* snapshot agent page.  revisiions to other data integration pages

* Consul Service Mesh TLS Provider page

* ServerTLS page

* Spelling, grammar errors

* Update website/content/docs/k8s/installation/vault/index.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/index.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/server-tls.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/connect-ca.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/gossip.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/snapshot-agent-config.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/bootstrap-token.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/connect-ca.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/enterprise-license.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/replication-token.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/data-integration/replication-token.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Updating data center to datacenter

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* interim changes

* more formatting changes

* adding additional formatting changes

* more formatting on systems integration page

* remove TODO

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/index.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/index.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Update website/content/docs/k8s/installation/vault/systems-integration.mdx

Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>

* Adding partition token

* removing dangling word

* Adding missing navlink for partitions page

* Adding VAULT_TOKEN documentation and a note to VAULT_ADDR about https and the possible need for the VAULT_CACERT.

* Fixing broken links and ordering lists

* Fixing broken links.  Changing pre-requisites to prerequisites.

Co-authored-by: David Yu <dyu@hashicorp.com>
Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>
2022-04-07 12:16:24 -06:00
Mike Morris 3b6fd762ae
website(api-gateway): add common errors page (#12643)
* Adding common errors page for API Gateway

* website(api-gateway): add missing CRDs common error message

* Update website/content/docs/api-gateway/common-errors.mdx

Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com>

* Update website/content/docs/api-gateway/common-errors.mdx

Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com>

* Update website/content/docs/api-gateway/common-errors.mdx

Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com>

* Update website/content/docs/api-gateway/common-errors.mdx

* Additional page editing instructions and formating

* Update website/content/docs/api-gateway/common-errors.mdx

* Update website/content/docs/api-gateway/common-errors.mdx

* Update website/content/docs/api-gateway/common-errors.mdx

* Update website/content/docs/api-gateway/common-errors.mdx

* Update website/content/docs/api-gateway/common-errors.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Apply suggestions from code review

Co-authored-by: Jeff-Apple <79924108+Jeff-Apple@users.noreply.github.com>
Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com>
Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2022-03-30 16:05:00 -04:00
Michele Degges 2f84aabffe
[RelAPI Onboarding] Add release API metadata file (#12591) 2022-03-28 13:45:53 -07:00
David Yu 6ab2507f18
docs: Consul K8s Overview update (#12575)
* docs: Consul K8s Overview update

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-03-18 12:01:41 -07:00
mrspanishviking 1ae820ea0a
Revert "[Docs] Agent configuration hierarchy " 2022-03-15 16:13:58 -07:00
trujillo-adam 667976c94f fixing merge conflicts part 3 2022-03-15 15:25:03 -07:00
trujillo-adam 60a88bb40f merging new hierarchy for agent configuration 2022-03-14 15:44:41 -07:00
trujillo-adam 19cfa8bcaa
Merge pull request #12460 from hashicorp/docs-day-acl-improvements
Docs day acl improvements
2022-03-08 19:34:26 -08:00
trujillo-adam d27895f068 renamed acl-overview to index, fixed formatting, reworded node/service ID intros 2022-03-01 10:03:22 -08:00
trujillo-adam b588620385 fixing merge conflicts 2022-03-01 09:08:20 -08:00
Evan Culver 3ca2d48bc8
Update latest version on website to 1.11.4 (#12469) 2022-02-28 16:53:28 -08:00
Jeff-Apple 333789355c
Merge pull request #12416 from hashicorp/api-gateway-ga-docs
website: update API Gateway docs for v0.1.0 GA release
2022-02-24 12:36:34 -08:00
John Murret 141a43409d
Adding documentation to store Enterprise License in Vault (#12375)
* Adding documentation to store Enterprise License in Vault

* Update website/content/docs/k8s/installation/vault/enterprise-license.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/enterprise-license.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/enterprise-license.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/enterprise-license.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/enterprise-license.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/installation/vault/enterprise-license.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Referencing Storing the Enterprise License in Vault from the Consul Enterprise installation instructions.

* Added missing words about stroing in Vault

* Update website/content/docs/k8s/installation/vault/enterprise-license.mdx

Co-authored-by: Kyle Schochenmaier <kschoche@gmail.com>

* Clarifying that enterprise code block is just changes on top of your normal config.

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
Co-authored-by: Kyle Schochenmaier <kschoche@gmail.com>
2022-02-23 14:20:45 -07:00
lornasong 4bc423204a
nia/docs 0.5.0 (#12381)
* docs/nia: new configuration for services condition & source_input (#11646)

* docs/nia: new configuration for services condition

* docs/nia: new configuration for services source_input

* reword filter and cts_user_defined_meta

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update service block config to table format

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Remove deprecated driver.working_dir (#11831)

* Deprecate workspace_prefix for now workspaces.prefix (#11836)

* docs/nia: new config field names for services condition/source_input (#11896)

* docs/nia: new config field `names` for services condition/source_input

* Remove language about 'default condition' and services condition relation to services list

Context:
 - Added a new `names` field to condition/source_input "services"
 - `names` or `regexp` must be configured for condition/source_input "services"

This therefore:
 - Removed relationship between condition/source_input "services" and
 task.services list
 - Removed concept of "default condition" i.e. condition "services" must be
 configured with `names` or `regexp`, there is no meaningful unconfigured default

Change: remove language regarding "default condition" and relationship with services list

* docs/nia: Update paramters to table format

Changes from a bulleted list to a table. Also adds the possible response codes
and fixes the update example response to include the inspect object.

* docs/nia: Delete task API and CLI

* docs/nia: Update wording for run values

Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com>

* docs/nia: require condition "catalog-services" block's regexp to be configured (#11915)

Changes:
 - Update Catalog Services Condition configuration docs to new table format
 - Rewrite `regexp` field docs to be required, no longer optional
 - Remove details about `regexp` field's original default behavior when the
 field was optional

* docs/nia: Update status API docs to table format

* Cleaner wording for response descriptions

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* docs/nia - 'source_includes_var' changes (#11939)

* docs/nia - condition "services" new field source_includes_var

 - Add new configuration details for condition "services" block's
 `source_includes_var` field.
 - Note: this field's description is worded differently from condition type's
 `source_includes_var` since a services variable is always required (unlike
 other vars) for CTS modules.
 - Also worded in a way to anticipate renaming to `use_as_module_input`

* docs/nia - change 'source_includes_var' default value from false to true

 - Update configs
 - Table-ify Consul-KV condition (reuse wording from Consul-KV source input)

* docs/nia - reword task execution page for source_includes_var changes

 - Note: switched to using "module input" language over "source input" language.
 Separate PR will make a mass change across docs
 - Slim down general task condition section to have fewer details on module input
 - Updated services, catalog-services, and consul-kv condition sections for
 source_includes_var
 - Add config page links for details

* Improve CTS acronym usage
- Use Consul-Terraform-Sync at the first instance with CTS in brackets - Consul-Terraform-Sync (CTS) and then CTS for all following instances on a per-page basis.
- some exceptions: left usage of the term `Consul-Terraform-Sync` in config examples and where it made sense for hyperlinking

* Improve CTS acronym usage (part 2) (#11991)

Per page:
- At first instance in text, use "Consul-Terraform-Sync (CTS)"
- Subsequent instances in text, use "CTS"

* Update schedule condition config to table format

* Update config tables with type column

* docs/nia: Update required fields values

Standardizing Required/Optional over boolean values.

* docs/nia: Standardize order of columns

Updated Required to come before Type, which is how the configurations are formatted. Also
changed the empty strings to "none" for default values.

* Deprecate port CLI option for CTS and updated example usage

* docs/nia cts multiple source input configuration updates (#12158)

* docs/nia cts multiple source input configuration updates

CTS expanded its usage of `source_input` block configurations and added
some restrictions. This change accounts for the following changes:

- `source_input` block can be configured for a task. No longer restricting to
scheduled task
- Multiple `source_input` blocks can be configured for a task. No longer
restricting to one
- Task cannot have multiple configurations defining the same variable type

Future work: We're planning to do some renaming from "source" to "module" for
v0.5. These changes are made in the code and not yet in the docs. These will be
taken care of across our docs in a separate PR. Perpetuating "source" in this
PR to reduce confusion.

* Apply suggestions from code review

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Apply suggestions from code review

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* code review feedback

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Add "Consul object" glossary entry

Changes:
 - Add "Consul object" to CTS glossary
 - Format glossary terms so that they can be linked
 - Add link to "Consul object" glossary entry

* Reorganize source_input limitations section

Co-authored-by: findkim <6362111+findkim@users.noreply.github.com>

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: findkim <6362111+findkim@users.noreply.github.com>

* docs/nia: overview of config streamlining deprecations (#12193)

* docs/nia: overview of config streamlining deprecations

* Update config snippets to use CodeTabs

* Apply code review feedback suggestions

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Apply suggestions from code review

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Clarify source table language

* Add use_as_module_input callout

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* docs/nia: deprecate "services" field and "service" block (#12234)

* Deprecate `services` field

Did a search on "`services`", "`task.services`", "services list", and "services
field"

Changes:
 - In config docs, mark `services` field as deprecated and `condition` block
 as required.
 - For necessary references to `services` field, mark with "(deprecated)" e.g.
 when listing all options for source input
 - Remove unnecessary references to `services` field from docs e.g. any docs
 encouraging use of `services`
 - Replace `services` field with `condition` / `module_input` "services" in
 config snippets and explanations

* Deprecate `service` block

Did a search for "service block", "`service`", and "service {"

Changes:
 - In config docs, mark `service` block as deprecated
 - For necessary references to `service` block, mark with "(deprecated)"
 - Remove unnecessary references to `service` block from docs

* Fix service block typos in config snippet

service block is singular and not plural

* docs/nia: deprecate "source includes var" and "source input" (#12244)

* Deprecate `source_includes_var` field

Did a search for "source_includes_var" and an audit of "include"

Changes
 - In config docs, mark `source_includes_var` field as deprecated
 - In config docs, add new field for `use_as_module_input`
 - For necessary references to `source_includes_var`, mark with "(deprecated)"
 - Audit and update "include" language

* Deprecate `source_input` field and language

Did a search and replace for "source_input", "source-input", "source input"

Changes:
 - In config docs, mark `source_input` field as deprecated
 - In config docs, add new entry for `module_input`
 - For necessary references to `source_input`, mark with "(deprecated)"
 - Remove or replace "source*input" with "module*input"

Note: added an anchor link alias e.g. `# Module Input ((#source-input))` for
headers that were renamed from "Source Input" so that bookmarked links won't
break

* Update config streamlining release removal version to 0.8

* remove duplicate bullet

* docs/nia: deprecate `source` (#12245)

* Update "source" field in config snippets to "module"

* Deprecate task config `source` field

Did a search and replace for "source" and "src"

Changes:
 - In config docs, mark `source` field as deprecated
 - In config docs, add new entry for `module`
 - Remove or replace "source" with "module"

* Deprecate Status API Event `source` field

Changes:
 - Mark `source` field as deprecated
 - Add new entry for `module`

* docs/nia - Get Task API docs & Task Status API deprecations (#12303)

* docs/nia - Get Task API

Added a Task Object section intended to be shared with the Create Task API

* docs/nia - Deprecate non-status fields from Task Status API

Deprecate the fields that Get Task API replaces

* docs/nia - Align API docs on `:task_name` request resource

Followed a convention found in Nomad docs

* docs/nia - misc fixes

Context for some:
 - remove "" from license_path for consistency - do not specify the default
 value when empty string
 - remove "optional" language from task condition. we want to move towards it
 being required

* docs/nia - add new columns to API Task Object

* Added Create Task API documentation

* Added create task CLI documentation

* addressed code review comments

* fixed example

* docs/nia: Update task delete with async behavior

CTS delete task command is now asynchronous, so updating docs to reflect
this new behavior.

* update create task CLI with new changes from code

* update create task api and cli
- update curl command to include the json header
- update example task names to use 'task_a' to conform with other examples

* docs/nia: Fix hyphens in CTS CLI output

* docs/nia: Add auto-approve option in CLI

* docs/nia: Clarify infrastructure is not destroyed on task deletion

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Kim Ngo <6362111+findkim@users.noreply.github.com>
Co-authored-by: Melissa Kam <mkam@hashicorp.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>
Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com>
Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
Co-authored-by: Michael Wilkerson <mwilkerson@hashicorp.com>
Co-authored-by: AJ Jwair <aj.jwair@hashicorp.com>
2022-02-23 14:22:34 -05:00
trujillo-adam dd89b6ba9b merged the k8s features section into the overview 2022-02-23 09:42:24 -08:00
trujillo-adam 282726af11 separating usage from overview content 2022-02-23 09:30:48 -08:00