Commit Graph

269 Commits (4f8594b28f796a0645643fdd4375b3a4360b1c0a)

Author SHA1 Message Date
Thomas Eckert 3c77a89414
Native API Gateway Docs (#16365)
* Create empty files

* Copy over content for overview

* Copy over content for usage

* Copy over content for api-gateway config

* Copy over content for http-route config

* Copy over content for tcp-route config

* Copy over content for inline-certificate config

* Add docs to the sidebar

* Clean up overview. Start cleaning up usage

* Add BETA badge to API Gateways portion of nav

* Fix header

* Fix up usage

* Fix up API Gateway config

* Update paths to be consistent w/ other gateway docs

* Fix up http-route

* Fix up inline-certificate

* rename path

* Fix up tcp-route

* Add CodeTabs

* Add headers to config pages

* Fix configuration model for http route and inline certificate

* Add version callout to API gateway overview page

* Fix values for inline certificate

* Fix values for api gateway configuration

* Fix values for TCP Route config

* Fix values for HTTP Route config

* Adds link from k8s gateway to vm gateway page

* Remove versioning warning

* Serve overview page at ../api-gateway, consistent w/ mesh-gateway

* Remove weight field from tcp-route docs

* Linking to usage instead of overview from k8s api-gateway to vm api-gateway

* Fix issues in usage page

* Fix links in usage

* Capitalize Kubernetes

* Apply suggestions from code review

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

* remove optional callout

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Apply suggestions from code review

* Update website/content/docs/connect/gateways/api-gateway/configuration/api-gateway.mdx

* Fix formatting of Hostnames

* Update website/content/docs/api-gateway/index.mdx

* Update website/content/docs/connect/gateways/api-gateway/configuration/http-route.mdx

Co-authored-by: Andrew Stucki <andrew.stucki@hashicorp.com>

* Add cross-linking of config entries

* Fix rendering error on new operator usage docs

* Update website/content/docs/connect/gateways/api-gateway/configuration/http-route.mdx

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

* Update website/content/docs/connect/gateways/api-gateway/configuration/http-route.mdx

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

* Apply suggestions from code review

* Apply suggestions from code review

* Add BETA badges to config entry links

* http route updates

* Add Enterprise keys

* Use map instead of list for meta field, use consistent formatting

* Convert spaces to tabs

* Add all Enterprise info to TCP Route

* Use pascal case for JSON api-gateway example

* Add enterprise to HCL api-gw cfg

* Use pascal case for missed JSON config fields

* Add enterprise to JSON api-gw cfg

* Add enterprise to api-gw values

* adds enterprise to http route

* Update website/content/docs/connect/gateways/api-gateway/index.mdx

Co-authored-by: danielehc <40759828+danielehc@users.noreply.github.com>

* Add enterprise to api-gw spec

* Add missing namespace, partition + meta to specification

* fixes for http route

* Fix ordering of API Gatetway cfg spec items

* whitespace

* Add linking of values to tcp

* Apply suggestions from code review

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

* Fix comma in wrong place

* Apply suggestions from code review

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

* Move Certificates down

* Apply suggestions from code review

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

* Tabs to spaces in httproute

* Use configuration entry instead of config entry

* Fix indentations on api-gateway and tcp-route

* Add whitespace between code block and prose

* Apply suggestions from code review

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

* adds <> to http route

---------

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
Co-authored-by: Melisa Griffin <melisa.griffin@hashicorp.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
Co-authored-by: Melisa Griffin <missylbytes@users.noreply.github.com>
Co-authored-by: Andrew Stucki <andrew.stucki@hashicorp.com>
Co-authored-by: danielehc <40759828+danielehc@users.noreply.github.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
2023-02-23 21:01:47 +00:00
Nathan Coleman b09d04a785
Update existing docs from Consul API Gateway -> API Gateway for Kubernetes (#16360)
* Update existing docs from Consul API Gateway -> API Gateway for Kubernetes

* Update page header to reflect page title change

* Update nav title to match new page title
2023-02-22 17:34:27 +00:00
Bryce Kalow 9edb625331
docs: update redirected links (#16179) 2023-02-07 10:36:32 -06:00
Ashlee M Boyer 6e425f7428
docs: Migrate link formats (#15976)
* Adding check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* Updating docs-content-check-legacy-links-format hash

* Migrating links to new format

Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 08:52:43 -08:00
Tu Nguyen 01a4510d6c
Update api gateway version to latest (#15197)
* Update api gateway version to latest

* Update website/content/docs/api-gateway/install.mdx

* update to latest apigw version 0.5.1

* update consul and helm version
2023-01-04 12:44:02 -08:00
Iryna Shustava 2be8b3326c
docs: remaining agentless docs updates (#15455)
* Update servers-outside-kubernetes.mdx

* Update single-dc-multi-k8s.mdx

* update Vault data integration for snapshot agent

* update k8s health checks page

* remove all instances of controller.enabled in helm values examples

* API Gateway update

* Apply suggestions from code review

Co-authored-by: Riddhi Shah <riddhi@hashicorp.com>

* Apply suggestions from code review

* Apply suggestions from code review

* Cleaner diagram

* added change around clients to workloads

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: boruszak <jeffrey.boruszak@hashicorp.com>
Co-authored-by: Riddhi Shah <riddhi@hashicorp.com>
Co-authored-by: David Yu <dyu@hashicorp.com>
2022-11-18 11:33:02 -06:00
trujillo-adam ab51aac7e0
Update docs for the release of Consul API Gateway v0.5 (#15015)
* added usage folder to organize use case docs for CAPIgw

* Add peer field to MeshService configuration page

* Add first pass at guide for routing to peered services

* Add exception to same-datacenter restriction for referenced Consul service

* Add example HTTPRoute referencing the MeshService as backendRef

* Add example ServiceResolver

* Add note about current ServiceResolver requirement

ServiceResolver may eventually be created implicitly by the API gateway controller, but that decision is pending.

* tweaks to the usage page for routing to peered services

* tweaks to the  description in the  configuration reference

* resolved TO-DOs from previous iteration

* Remove datacenter federation from limited support matrix

* added tolerations doc

* Remove note excluding k8s 1.24 since we now support it

* Reorder sections to maintain alphabetical sort

* Add example configuration for MeshService resource

* Adjust wording + indentation of other docs

* Use consistent "example-" prefix for resource names in example code

* reframed the tolerations documentation; STILL A WIP

* add helm chart documentation

* removed tolerations from gwcconfig configuration model reference

* 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>

* update version to 0.5.0

* Update install.mdx

* added release notes for v.0.5.x

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
Co-authored-by: Sarah Alsmiller <sarah.alsmiller@hashicorp.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com>
2022-11-17 15:42:25 -08:00
Nathan Coleman 2f005f2086
Update required Helm chart version to match APIGW release notes (#15168) 2022-10-31 16:31:10 -04:00
Nathan Coleman 5d73fda1f4
Fix broken link in Consul API Gateway docs 2022-10-28 15:01:38 -04:00
Bryce Kalow eb6254c96d
docs: fix malformed yaml (#14952) 2022-10-11 12:25:19 -05:00
boruszak 38b1a515f1 Mergimg 2022-10-11 10:10:00 -05:00
Jeff Boruszak 9cd63ba543
Apply suggestions from code review
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-10-11 09:34:36 -05:00
Jeff Boruszak 74f08b9667
Apply suggestions from code review
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Luke Kysow <1034429+lkysow@users.noreply.github.com>
Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>
2022-10-11 09:34:17 -05:00
boruszak 50b238addc /docs/api-gateway/configuration
/docs/api-gateway/
2022-09-23 15:59:02 -05:00
trujillo-adam b7fe014cbf fixed typos in CAPIgw usage docs 2022-09-23 09:23:21 -07:00
Blake Covarrubias 25cfe31507
docs: Fix spelling errors on website (#14634) 2022-09-15 09:03:12 -07:00
Bryce Kalow 85c1a33c42
website: content updates for developer (#14419)
Co-authored-by: Ashlee Boyer <ashlee.boyer@hashicorp.com>
Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com>
Co-authored-by: Kevin Wang <kwangsan@gmail.com>
2022-09-14 17:45:42 -05:00
Jeff Apple 776c98d109
Update website/content/docs/api-gateway/tech-specs.mdx 2022-09-08 14:41:06 -07:00
Nathan Coleman f0e8d44c80
Update website/content/docs/api-gateway/tech-specs.mdx 2022-09-08 15:56:28 -04:00
Jeff Apple 86754cfe5a
Update website/content/docs/api-gateway/tech-specs.mdx
Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
2022-09-08 12:55:15 -07:00
Jeff Apple 402ddd6dcd
Update website/content/docs/api-gateway/tech-specs.mdx
Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
2022-09-08 12:54:02 -07:00
Jeff Apple a1eb38213a
Update website/content/docs/api-gateway/tech-specs.mdx
Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
2022-09-08 12:51:44 -07:00
Jeff Apple 16f5d7c381
Docs: add limitations to Tech Specs 2022-09-08 11:38:27 -07:00
Nathan Coleman c1be820d85
Update website/content/docs/api-gateway/configuration/gateway.mdx
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-08-22 16:22:43 -04:00
Nathan Coleman 596ab31262
Apply suggestions from code review
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-08-22 15:14:30 -04:00
Nathan Coleman 226bfa8203
Update website/content/docs/api-gateway/configuration/gateway.mdx 2022-08-22 14:40:43 -04:00
Nathan Coleman 022c155660
Apply suggestions from code review
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-08-22 14:31:19 -04:00
Nathan Coleman 48e7af89b2 Correct structure of existing tls.certificateRefs example 2022-08-22 12:34:16 -04:00
Nathan Coleman 9c72169d26 Add example code for cross-namespace certificateRefs 2022-08-22 12:33:42 -04:00
Nathan Coleman 23ef639c6d
Fix typo 2022-08-15 17:21:36 -04:00
Nathan Coleman 10b89163e4
Apply suggestions from code review 2022-08-15 17:13:44 -04:00
trujillo-adam 01a34917cd
Apply suggestions from code review
Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
2022-08-15 14:02:46 -07:00
Nathan Coleman 0d432e66ff
Merge branch 'docs/capigw-v0.4.0' into docs/capigw-040-route-details-prefix-rewrite 2022-08-15 12:01:19 -04:00
Nathan Coleman b6e1962265 Update ReferencePolicy -> ReferenceGrant 2022-08-15 11:56:54 -04:00
Nathan Coleman c10464fc0b Add missing code block 2022-08-15 11:49:41 -04:00
Nathan Coleman ff11876f1e Replace MeshService section on Route page w/ link to new page 2022-08-15 11:16:38 -04:00
Nathan Coleman 467bfb15ac Add page for MeshService configuration object for Consul API Gateway 2022-08-15 11:13:18 -04:00
Nathan Coleman 3f9debf7a1 Fix typo in Gateway docs header 2022-08-15 11:12:58 -04:00
trujillo-adam ecf9a749aa implemented additional information about route configuration 2022-08-14 10:53:43 -07:00
trujillo-adam d055cfd7a2 added configuration model for routes 2022-08-11 20:50:38 -07:00
trujillo-adam 54e7924943 added usage docs for prefix rewrite 2022-08-11 20:19:51 -07:00
trujillo-adam 1610fb0315 updated Routes configuration ref 2022-08-11 20:10:36 -07:00
Mike Morris 0cf4afb18f
docs(capigw): add v0.4.0 upgrade instructions (#14101)
docs(capigw): add manual ReferencePolicy -> ReferenceGrant migration steps, comment out kube-storage-version-migrator workflow in case we choose to publish it later
2022-08-11 13:32:34 -04:00
Sarah Alsmiller b9f70c0bf1 fix identation 2022-08-08 10:16:24 -05:00
Sarah Alsmiller 4b8b1b502c revert indent 2022-08-08 09:33:22 -05:00
Sarah Alsmiller c8e78f1f8d test 2022-08-08 09:32:28 -05:00
Sarah Alsmiller 6e80e6ab37 indentation 2022-08-08 09:21:51 -05:00
sarahalsmiller 62142aa921
Update website/content/docs/api-gateway/configuration/gateway.mdx 2022-08-08 09:16:36 -05:00
Sarah Alsmiller da38571f4b Merge branch 'sa-restructure-documentation' of github.com:hashicorp/consul into sa-restructure-documentation 2022-08-05 10:38:31 -05:00
Sarah Alsmiller c71bc86d2a note rendering weird 2022-08-05 10:38:20 -05:00