Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: v2 and multiport updates for v1.18 #20705

Merged
merged 13 commits into from
Feb 28, 2024
Merged

Conversation

boruszak
Copy link
Contributor

@boruszak boruszak commented Feb 22, 2024

Description

This PR contains docs updates improvements to Consul's v2 architecture and support for multi-port services. It makes the following changes:

  • Moves consul resource command to the CLI section
  • Creates new "v2 architecture" section with its own landing page
  • Separates catalog and resource group pages
  • Removes "Beta" callouts
  • Moves "v1 catalog" page
  • Changes references to consul v1.17 and consul-k8s v1.3 to v1.18 and 1.4
  • Redirects created to support changes

Links

Deployment preview

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Feb 22, 2024
@boruszak boruszak added pr/no-changelog PR does not need a corresponding .changelog entry pr/no-metrics-test backport/1.18 labels Feb 22, 2024
@boruszak boruszak marked this pull request as ready for review February 26, 2024 21:27
@boruszak boruszak requested a review from a team as a code owner February 26, 2024 21:27
@david-yu
Copy link
Contributor

@boruszak Could you incorporate changes from #20696 as well? I believe it's easier to think about the changes as v2 catalog instead of multi-port services. As v2 covers both the multi-port workload use case as well as the multiple services directing traffic to a single workload use case.

@david-yu
Copy link
Contributor

Another catch in the docs for Configure Multi-port

Consul's v2 catalog supports two methods for defining multi-port services in Kubernetes:

Could we say the following instead?

Consul's v2 catalog supports two new methods for registering services on the mesh in Kubernetes:

Method 1: Register a Kubernetes service that select workloads which expose multiple ports
Method 2: Register multiple Kubernetes Services that direct traffic to an explicit port on the same workload. 

@david-yu david-yu mentioned this pull request Feb 28, 2024
4 tasks
@boruszak boruszak enabled auto-merge (squash) February 28, 2024 01:10
@boruszak boruszak merged commit 90d3a7c into main Feb 28, 2024
61 checks passed
@boruszak boruszak deleted the docs/v2-changes-v1-18-release branch February 28, 2024 01:14
boruszak added a commit that referenced this pull request Feb 28, 2024
* Move consul resource page + redirect

* Updates for v1.18

* Remove beta warning

* Secondary datacenter constraint

* Clarify transparent proxy in prereqs

* Config entry mention

* requested improvements

* suggestions from review

* additional suggestion
boruszak added a commit that referenced this pull request Feb 28, 2024
docs: v2 and multiport updates for v1.18 (#20705)

* Move consul resource page + redirect

* Updates for v1.18

* Remove beta warning

* Secondary datacenter constraint

* Clarify transparent proxy in prereqs

* Config entry mention

* requested improvements

* suggestions from review

* additional suggestion
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/no-changelog PR does not need a corresponding .changelog entry pr/no-metrics-test type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants