Skip to content

Update consul-k8s CLI docs#15647

Closed
Ranjandas wants to merge 1 commit intohashicorp:mainfrom
Ranjandas:docs/consul-k8s-fixes
Closed

Update consul-k8s CLI docs#15647
Ranjandas wants to merge 1 commit intohashicorp:mainfrom
Ranjandas:docs/consul-k8s-fixes

Conversation

@Ranjandas
Copy link
Copy Markdown
Contributor

Description

The Consul-K8S with version 1.0.0 has introduced some changes, and his PR incorporates those changes.

Links

hashicorp/consul-k8s#1755

PR Checklist

  • updated test coverage
  • external facing docs updated
  • not a security concern

@Ranjandas Ranjandas requested a review from a team as a code owner December 2, 2022 03:23
@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Dec 2, 2022
@Ranjandas Ranjandas requested a review from david-yu December 11, 2022 21:50
Copy link
Copy Markdown
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

Looks good. I just have a few changes for consistency with our style guide.

$ export VERSION=1.0 && \
curl --location "https://releases.hashicorp.com/consul-k8s/${VERSION}/consul-k8s_${VERSION}_darwin_amd64.zip" --output consul-k8s-cli.zip
$ export VERSION=0.49.0 && \
curl -L "https://releases.hashicorp.com/consul-k8s/${VERSION}/consul-k8s_${VERSION}_darwin_$( [ $(uname -m) = aarch64 ] && echo arm64 || echo amd64).zip" -o consul-k8s-cli.zip
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
curl -L "https://releases.hashicorp.com/consul-k8s/${VERSION}/consul-k8s_${VERSION}_darwin_$( [ $(uname -m) = aarch64 ] && echo arm64 || echo amd64).zip" -o consul-k8s-cli.zip
curl --location "https://releases.hashicorp.com/consul-k8s/${VERSION}/consul-k8s_${VERSION}_darwin_$( [ $(uname -m) = aarch64 ] && echo arm64 || echo amd64).zip" --output consul-k8s-cli.zip

Per the style guide, we should use the long flag name.

After installing the Consul K8s CLI tool (`consul-k8s`), issue the `install` subcommand and any additional options to install Consul on Kubernetes.
Refer to the [Consul K8s CLI reference](/docs/k8s/k8s-cli) for details about all commands and available options.
If you do not include any additional options, the `consul-k8s` CLI installs Consul on Kubernetes using the default settings form the Consul Helm chart values.
The following example installs Consul on Kubernetes with Service Mesh and CRDs enabled with the `quickstart` preset. If you are using `consul-k8s` < 1.0.0 use the `demo` preset instead.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
The following example installs Consul on Kubernetes with Service Mesh and CRDs enabled with the `quickstart` preset. If you are using `consul-k8s` < 1.0.0 use the `demo` preset instead.
The following example installs Consul on Kubernetes with Service Mesh and CRDs enabled with the `quickstart` preset. If you are using `consul-k8s` 1.0.0 or later, use the `demo` preset instead.

Per the style guide, don't use mathematical symbols in prose.

@github-actions
Copy link
Copy Markdown

This pull request has been automatically flagged for inactivity because it has not been acted upon in the last 60 days. It will be closed if no new activity occurs in the next 30 days. Please feel free to re-open to resurrect the change if you feel this has happened by mistake. Thank you for your contributions.

@github-actions github-actions bot added the meta/stale Automatically flagged for inactivity by stalebot label Jun 12, 2023
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 4, 2024

Closing due to inactivity. If you feel this was a mistake or you wish to re-open at any time in the future, please leave a comment and it will be re-surfaced for the maintainers to review.

@github-actions github-actions bot closed this Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

meta/stale Automatically flagged for inactivity by stalebot type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants