Skip to content

docs: replace the retired Helm incubator instructions - #1252

Open
afruktin wants to merge 1 commit into
SpectoLabs:masterfrom
afruktin:docs/kubernetes-helm-chart
Open

afruktin wants to merge 1 commit into
SpectoLabs:masterfrom
afruktin:docs/kubernetes-helm-chart

Conversation

@afruktin

Copy link
Copy Markdown

The Kubernetes section of the installation page no longer works:

  • https://kubernetes-charts-incubator.storage.googleapis.com/ answers 403: the incubator repository was deprecated together with helm/charts in November 2020.
  • helm install incubator/hoverfly is Helm 2 syntax. Helm 3 stops with Error: INSTALLATION FAILED: must either provide a name or specify --generate-name.

As noted in #366, there has been no official chart since. This PR points the section at a community-maintained chart on Artifact Hub and otherwise keeps it as it was: add the repository, install with the default settings, port-forward. Two small corrections on the way: the port-forward targets the Service, so the Pod name lookup is gone, and the section mentions that the default installation runs Hoverfly in webserver mode.

Disclosure: I maintain the chart (https://github.com/afruktin/hoverfly-helm). It runs the unmodified spectolabs/hoverfly image and follows Hoverfly releases, currently v1.12.16. CI lints every change, installs it on a kind cluster and checks that simulations survive a Pod restart. Should the chart ever stop being maintained, I will send a PR removing this section. And if you would rather not link a third-party chart at all, I am happy to reduce this PR to removing the dead instructions.

How to test: run the commands from the updated section as written. On a kind cluster, curl http://127.0.0.1:8888/api/health then answers {"message":"Hoverfly is healthy"}. Building the docs with the pinned docs/requirements.txt adds no warnings.

The Kubernetes section still pointed at the Helm incubator repository,
which was deprecated together with helm/charts in November 2020: its URL
now answers 403, and `helm install incubator/hoverfly` is Helm 2 syntax
that Helm 3 rejects without a release name.

Point the section at a community-maintained chart on Artifact Hub and keep
its structure: add the repository, install with the default settings,
port-forward. Forwarding the Service replaces the Pod name lookup, and the
section now says that the default installation runs Hoverfly in webserver
mode.

Refs SpectoLabs#366

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant