Skip to content

Add link to Helm in README #6583

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

Merged
merged 1 commit into from
Jul 16, 2025
Merged

Add link to Helm in README #6583

merged 1 commit into from
Jul 16, 2025

Conversation

b10n1k
Copy link
Contributor

@b10n1k b10n1k commented Jul 10, 2025

A link to the helm's README added besides some extensions in its guides and the steps which likely needs for getting started with the charts.

poo: https://progress.opensuse.org/issues/183608


```
kubectl get pods [--all-namespaces]
kubectl get pods -n ingress-nginx
Copy link
Member

Choose a reason for hiding this comment

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

Why the namespace ingress-nginx? Where is it used?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it is the default nemaspace for ingress. and it is where the ingress controller runs and handles the routing to the services

Copy link
Member

Choose a reason for hiding this comment

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

Nope, that depends on:

  1. what type of ingress to you have (if any)
  2. what type of kubernetes distribution do you have
  3. your settings
    I do not think there is a sensible default.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess you can resolve this as well with the change from #6583 (comment)

Comment on lines 44 to 47
For testing, it is also useful to create a my_values.yaml and run

```
helm install openqa helm/charts/openqa/ -f my-values.yaml
Copy link
Member

Choose a reason for hiding this comment

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

Either my_values.yaml or my-values.yaml but not both.

archives and rerun `helm dependency update charts/openqa/`.


Check that everything is up and running
Copy link
Member

Choose a reason for hiding this comment

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

Wouldn't helm list or helm status be better suited to get the required information about the helm deployment?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess, it can be used as well. but kubectl will show the pods names where the helm I think lists the running services. Would you like to extend the text to include those too?

Copy link
Member

Choose a reason for hiding this comment

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

If you use helm status --show-resources, you will see all the resources (i.e. including pods, deployments, services).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

researched and updated. helm status --show-resources is it.

Copy link

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

This is an automatically generated QA checklist based on modified files.

Copy link

codecov bot commented Jul 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.11%. Comparing base (2f1c94d) to head (febd545).
Report is 12 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6583   +/-   ##
=======================================
  Coverage   99.11%   99.11%           
=======================================
  Files         399      399           
  Lines       40717    40717           
=======================================
  Hits        40358    40358           
  Misses        359      359           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@Martchus Martchus left a comment

Choose a reason for hiding this comment

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

Please don't omit punctuation when writing documentation.

Comment on lines 29 to 30

Check that everything is up and running
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Check that everything is up and running
Check that everything is up and running:


## Configuration

It might be necessary to customize the charts by overriding some of the
variables inside _charts/values.yaml_ to suit your needs.

For testing, it is also useful to create a my_values.yaml and run
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For testing, it is also useful to create a my_values.yaml and run
For testing, it is also useful to create a `my_values.yaml` and run:

A link to the helm's README added besides some extensions in its guides and
the steps which likely needs for getting started with the charts.

poo: https://progress.opensuse.org/issues/183608
Signed-off-by: Ioannis Bonatakis <[email protected]>
@mergify mergify bot merged commit 12f3e8e into os-autoinst:master Jul 16, 2025
51 checks passed
os-autoinst-bot pushed a commit to os-autoinst-bot/openQA that referenced this pull request Jul 17, 2025
commit 12f3e8e
Merge: a61b311 febd545
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Wed Jul 16 18:36:22 2025 +0000
Commit:     GitHub <[email protected]>
CommitDate: Wed Jul 16 18:36:22 2025 +0000

    Merge pull request os-autoinst#6583 from b10n1k/helm_docs

    Add link to Helm in README
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.

4 participants