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

chore(notes): simplify post-install steps for ClusterIP service case #178

Merged
merged 7 commits into from
Jul 18, 2024

Conversation

tthvo
Copy link
Member

@tthvo tthvo commented Jul 17, 2024

Related to #177, #160

Descriptions

  • Simplify post-install steps for ClusterIP service case.
  • Use generic word application to refer to Cryostat in release notes. I suppose installing Cryostat chart already means installing Cryostat (See ci(oci): helm repackaging #177 (comment))

Motivations

When installing the chart without further customizations, the user just needs to port-forward the local port to the application pod. Previously, there were some extra steps that only defined some environment variables (i.e. not actually configuring cryostat).

How to test

helm install cryostat-sample charts/cryostat

Expected notes:

NOTES:

1. Configure the application to serve external traffic:
  ```
  No actions required with this configuration.
  ```

2. Forward local port to the application's pod:
  ```
  kubectl -n default wait --for=condition=available --timeout=60s deploy/cryostat-sample

  export POD_NAME=$(kubectl get pods -n default -l "app.kubernetes.io/name=cryostat,app.kubernetes.io/instance=cryostat-sample" --sort-by=.metadata.creationTimestamp -o jsonpath="{.items[-1:].metadata.name}")
  export CONTAINER_PORT=$(kubectl get pod -n default $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
  kubectl -n default port-forward $POD_NAME "8080:$CONTAINER_PORT"
  ```

3. Visit the application at:
  ```
  http://localhost:8080
  ```

@tthvo tthvo added chore Refactor, rename, cleanup, etc. safe-to-test labels Jul 17, 2024
@tthvo tthvo requested a review from a team July 17, 2024 23:31
@andrewazores andrewazores merged commit 07ebd17 into cryostatio:main Jul 18, 2024
5 checks passed
@tthvo tthvo deleted the release-notes branch July 18, 2024 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Refactor, rename, cleanup, etc. safe-to-test
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants