Skip to content

Helm notes are slightly confusing as part of quickstart #144

@lann

Description

@lann

This is a pretty small papercut but threw me off just enough to lose the flow.

The Quickstart guide has you (among other steps):

  • "Apply the Runtime Class"
  • "Install Spin Operator with Helm", which prints NOTES.txt, which tells you:
    • "If you haven't already done so, please ensure the following:"
      • "Install the containerd-shim-spin SpinAppExecutor"
      • "Install the wasmtime=spin-v2 RuntimeClass"
  • "Lastly, create the shim executor"

Both the Quickstart and the Helm notes make sense on their own, but combined it is confusing what steps are actually required because the RuntimeClass and SpinAppExecutor steps are duplicated but reordered and interleaved. Luckily duplicating these steps is a no-op which is what makes this a "pretty small papercut".

Adding a bit to the confusion about "If you haven't already done so", the kubectl apply URLs between the Quickstart and Helm notes are just different enough to make it unclear whether they are pointing to the same things:

# Quickstart
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.runtime-class.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.shim-executor.yaml
# Helm notes
kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/spin-runtime-class.yaml
kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/spin-shim-executor.yaml

They currently are the same, though one pointing at a release and the other pointing at main could cause them to go out of sync in the future, especially if someone was trying to install an old Helm chart version.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: installationContent related to installation guides.discussionOngoing discussion that has not reached consensus.

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions