Commit Graph

79 Commits

Author SHA1 Message Date
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
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
Andrew Stucki 70dabc551f Add k8s features 2022-02-23 11:15:58 -05:00
trujillo-adam c57ab13f7d separated overview content and usage content into their own pages 2022-02-22 16:44:30 -08:00
Nathan Coleman d3eb57ad9d Adjust navigation for Consul API Gateway 2022-02-22 18:02:53 -05:00
Eric 8c8001afee Document Consul ECS resource usage
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Paul Glass <pglass@hashicorp.com>
2022-02-18 09:30:57 -05:00
trujillo-adam f36d18c469 added 'Tech Specs' section under API Gateway 2022-02-16 11:54:43 -08:00
Thomas Eckert 375524df84
Separate Annotations/Labels and Add `service-ignore` to Docs (#12323)
* Separate Annotations and Labels and add service-ignore label

* changes to structure and call out for pod

* add description and TOC

* Update annotations-and-labels.mdx

Co-authored-by: David Yu <dyu@hashicorp.com>
2022-02-16 09:53:13 -08:00
trujillo-adam 919f32270a Refactored the ACL documentation 2022-02-09 16:07:49 -08:00
David Yu 173a238eba
docs: mention Consul API gateway in Ingress Controllers page (#12268)
* docs: mention Consul API gateway

* Remove Ambassador integration

* Update ingress-controllers.mdx

* Update website/content/docs/k8s/connect/ingress-controllers.mdx

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

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2022-02-04 09:23:55 -08:00
Karl Cardenas 3665e95f99
Merge branch 'main' of github.com:hashicorp/consul into what_service_mesh 2022-02-04 09:00:14 -07:00
trujillo-adam 93cff86480
Merge pull request #11951 from hashicorp/docs/api-gateway-beta
API gateway docs going live for beta
2022-01-27 13:38:08 -08:00
Paul Glass 750d3e645b docs: Add configuration reference for ECS 2022-01-27 11:34:49 -06:00
Paul Glass 558967c767 docs: Manual secure configuration for ECS 2022-01-27 11:34:49 -06:00
Paul Glass 35b37345be docs: Correct ECS filename -> manual-installation.mdx 2022-01-27 11:34:48 -06:00
Paul Glass 5a98efcf56 docs: Manual installation of Consul on ECS 2022-01-27 11:34:48 -06:00
Paul Glass 446355ff69 docs: Unmerge ECS architecture from overview 2022-01-27 11:34:48 -06:00
Paul Glass fbbe71415a docs: Flatten ECS "Getting Started" navigation 2022-01-27 11:34:48 -06:00
Paul Glass 29bd32c9ce docs: Merge ECS Architecture into overview 2022-01-27 11:34:48 -06:00
David Yu d7418df51d
docs: 1.11.0 release notes (#12138)
* Work in Progress

* edit nav to show 1.11

* slight updates to release note content

* acl changes

* add details on bbolt

* first draft

* add more admin partition details

* revert package-lock.json

* Update website/content/docs/release-notes/1-11-0.mdx

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

* Update website/content/docs/release-notes/1-11-0.mdx

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

* Update website/content/docs/release-notes/1-11-0.mdx

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

* Update website/content/docs/release-notes/1-11-0.mdx

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

* Update website/content/docs/release-notes/1-11-0.mdx

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

* Update website/content/docs/release-notes/1-11-0.mdx

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

* add sds change, and 1.10 change for tproxy

* Small changes

* Update website/content/docs/release-notes/1-11-0.mdx

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

* Update website/content/docs/release-notes/1-11-0.mdx

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

* adding Consul Service mesh term

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2022-01-21 15:46:02 -08:00
David Yu d8b9eb7756
docs: Add specific version install guide for `consul-k8s` CLI, refactor install (#12114)
* docs: Add specific version install guide for `consul-k8s` CLI

* parameterize version

* remove extra path

* Update k8s-cli.mdx

* slight formatting

* Update k8s-cli.mdx

* specific version details in overall install guide

* shell details

* Update install.mdx

* Update k8s-cli.mdx

* Update install.mdx

* broken link

* typo

* Update website/content/docs/k8s/installation/compatibility.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/k8s-cli.mdx

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

* Update website/content/docs/k8s/installation/install.mdx

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

* moving install cli commands to separate page

* add tabs, wip

* add specific distro install guides

* add upgrade tabs

* build failure

* not sure why heading is not working

* remove whitespace

* add more whitespace

* fixes on formatting

* remove package lock

* add back package lock json

* test

* latest

* remove modified file

* adding fix to yum install

* create folder for upgrade and move upgrade cli there

* revert package-lock

* adding upgrade file

* Update website/content/docs/k8s/upgrade/upgrade-cli.mdx

Co-authored-by: Thomas Eckert <teckert@hashicorp.com>

* Update website/content/docs/k8s/installation/install-cli.mdx

Co-authored-by: Thomas Eckert <teckert@hashicorp.com>

* Update website/content/docs/k8s/installation/install-cli.mdx

Co-authored-by: Thomas Eckert <teckert@hashicorp.com>

* Update install-cli.mdx

* multi-line copy

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
Co-authored-by: Thomas Eckert <teckert@hashicorp.com>
2022-01-20 08:26:31 -08:00
Karl Cardenas 9cfcd1af39
Merge branch 'main' of github.com:hashicorp/consul into what_service_mesh 2022-01-18 15:11:48 -07:00
David Yu 0f3636a741
docs: move K8s compatability matrix and add more details for compatibility (#11936)
* adding changes to move compat matrix

* add back compat matrix

* add Vault versions

* adding details around monorepo

* add note about secrets backend

* small refactors

* Slight update with OpenShift notes

* Add note about OpenShift 4.4.x

* Update website/content/docs/k8s/installation/compatibility.mdx

Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>

* small formatting

* Removing Consul image column from Vault as secrets backend section

Since we already imply that default consul-k8s image should be used for support

* formating changes

Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2022-01-18 10:33:26 -08:00
Preetha 6826923f32
Add new page on multi DC ACLs (#12020)
New docs page that details the steps needed to configure ACLS and replication in federated datacenters.
2022-01-14 18:32:44 -06:00
Karl Cardenas 5d7a727e1c
Merge branch 'main' of github.com:hashicorp/consul into what_service_mesh 2022-01-14 08:49:44 -07:00
trujillo-adam 2e90c9075d moved consul api gateway to top of nav hierarchy 2022-01-12 14:04:03 -08:00
trujillo-adam 0d69bb1902 added beta flag to nav link 2022-01-12 11:32:32 -08:00
Luke Kysow e30e0a075c
Add distributed tracing docs (#12010)
* Add distributed tracing docs
2022-01-10 15:43:31 -08:00
Karl Cardenas 9fef606615
initializing SEO updates 2022-01-06 13:57:22 -07:00
trujillo-adam 39def0fefe initial commit/draft of the API gateway docs 2022-01-05 18:45:00 -08:00
trujillo-adam 2edf383b79
Merge pull request #11859 from hashicorp/docs/service-mesh-gateways-clarification-for-1.11.0
clarify mesh gateway docs use cases; include admin partition flow
2021-12-22 11:56:11 -08:00
David Yu ee3de02ea4
docs: Remove BETA from Admin Partitions (#11862) 2021-12-15 19:37:07 -08:00
trujillo-adam 478e988206 clarify mesh gateway docs use cases; include admin partition flow 2021-12-15 13:11:52 -08:00
Kyle Schochenmaier cef506ce6d
docs: consul-vault kubernetes integration docs (#11766)
* Add documentation for the consul with vault integration that covers Server TLS, Connect CA and gossip encryption

Co-authored-by: David Yu <dyu@hashicorp.com>
Co-authored-by: Iryna Shustava <iryna@hashicorp.com>
2021-12-15 12:59:36 -06:00
freddygv a2fd30e514 Clean up additional refs to partition exports 2021-12-04 15:16:40 -07:00
freddygv 02fb323652 Rename partition-exports to exported-services
Using a name less tied to partitions gives us more flexibility to use
this config entry in OSS for exports between datacenters/meshes.
2021-12-03 17:47:31 -07:00
trujillo-adam cff9356f97
Merge pull request #11558 from hashicorp/docs/admin-partitions-service-exports-configuration-entry
Admin partition docs: cross-partition support beta2/3
2021-11-30 11:22:30 -08:00
Luke Kysow b356a7cdc9
Add docs for Consul Ent on ECS (#11537) 2021-11-17 09:59:32 -08:00
Paul Glass 5f5c5d1d7a docs: ECS docs for GA 2021-11-16 10:55:23 -06:00
trujillo-adam b937934b35 first commit for cross-partition support - partition exports section 2021-11-11 18:43:57 -08:00
Karl Cardenas 899d21cf4f
docs: added link to Ambassador tutorial in k8s section 2021-11-09 07:51:17 -07:00
Karl Cardenas 256b0127bd
docs: removed broken link to Ambassador 2021-11-08 07:46:38 -07:00
trujillo-adam e515657de2 initial commit adding admin partitions section to docs - several more changes to come 2021-10-14 16:14:05 -07:00
David Yu eb414d4884
docs: Remove Ambassador docs since they are outdated and link to Learn Guide (#11251)
* docs: Remove Ambassador docs since they are outdated
* Relink to Learn guide
2021-10-08 09:05:25 -07:00