Skip to content

Backport of docs: Remove YAML service registration examples into release/1.15.x#18905

Merged
hc-github-team-consul-core merged 1 commit into
release/1.15.xfrom
backport/docs/remove-k8s-yaml-service-registration/typically-meet-lion
Sep 19, 2023
Merged

Backport of docs: Remove YAML service registration examples into release/1.15.x#18905
hc-github-team-consul-core merged 1 commit into
release/1.15.xfrom
backport/docs/remove-k8s-yaml-service-registration/typically-meet-lion

Conversation

@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator

Backport

This PR is auto-generated from #18877 to be assessed for backporting due to the inclusion of the label backport/1.15.

The below text is copied from the body of the original PR.


Description

Remove YAML service registration examples and replace them with JSON. This is because YAML is not a supported configuration format for the Consul's agent configuration, nor is it supported by the HTTP API.

This commit replaces the YAML examples with JSON and adds additional JSON examples where they were missing.

PR Checklist

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

Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core requested a review from a team as a code owner September 19, 2023 18:41
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/remove-k8s-yaml-service-registration/typically-meet-lion branch from bb2750c to de7a901 Compare September 19, 2023 18:41
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/remove-k8s-yaml-service-registration/typically-meet-lion branch from cab0573 to 9c41249 Compare September 19, 2023 18:41
@github-actions github-actions Bot added the type/docs Documentation needs to be created/updated/clarified label Sep 19, 2023
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto approved Consul Bot automated PR

@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator Author

🤔 This PR has changes in the website/ directory but does not have a type/docs-cherrypick label. If the changes are for the next version, this can be ignored. If they are updates to current docs, attach the label to auto cherrypick to the stable-website branch after merging.

@vercel vercel Bot temporarily deployed to Preview – consul September 19, 2023 18:52 Inactive
@hc-github-team-consul-core hc-github-team-consul-core merged commit 45223b7 into release/1.15.x Sep 19, 2023
@hc-github-team-consul-core hc-github-team-consul-core deleted the backport/docs/remove-k8s-yaml-service-registration/typically-meet-lion branch September 19, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants