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

added helm repo yaml in docs folder #194

Merged
merged 3 commits into from
Jun 25, 2020

Conversation

kferrone
Copy link
Contributor

@kferrone kferrone commented Jun 23, 2020

This will allow helm to add the public docs of this git repo as a helm
repo. The helm tar packages are actually stored in git releases still.

Is this a bug fix or adding new feature?
A new feature as this repo did not have a public helm repo and required installing the charts tar.gz directly.

What is this PR about? / Why do we need it?
Not all ways of using helm will allow you to install a chart from a url. Installing charts from a repo always works. For example if you are using FluxCD Helm Operator or AWS CDK, they do not support installing from url directly without a specific repo. . . as far as I know.

What testing is done?
I have done this before. I can't directly test this repo until the docs folder is made public.

As long as the docs folder is public on Github Pages then the following command would work:

helm repo add aws-efs https://kubernetes-sigs.github.io/aws-efs-csi-driver
helm upgrade -i aws-efs-csi-driver aws-efs/aws-efs-csi-driver --namespace kube-system

I made this exact repo available on my account to test out.
Add the repo

helm repo add aws-efs https://kferrone.github.io/aws-efs-csi-driver

Search the repo:

helm search repo aws-efs

which should display:

NAME                            CHART VERSION   APP VERSION     DESCRIPTION                        
aws-efs/aws-efs-csi-driver      0.1.0           0.3.0           A Helm chart for AWS EFS CSI Driver

Now try a pull and see the download:

helm pull aws-efs/aws-efs-csi-driver

Fixes: #146

This will allow helm to add the public docs of this git repo as a helm
repo. The helm tar packages are actually stored in git releases still.
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jun 23, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @kferrone!

It looks like this is your first PR to kubernetes-sigs/aws-efs-csi-driver 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/aws-efs-csi-driver has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 23, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @kferrone. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 23, 2020
kferrone added 2 commits June 23, 2020 13:29
This will allow helm to add the public docs of this git repo as a helm
repo. The helm tar packages are actually stored in git releases still.
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 23, 2020
@kferrone
Copy link
Contributor Author

I signed it

@leakingtapan
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 25, 2020
@leakingtapan
Copy link
Contributor

Thx for creating the helm index! I will move the file to github page in a separate branch and make it public once this is merged.

@leakingtapan
Copy link
Contributor

leakingtapan commented Jun 25, 2020

Just created gh-pages branch, please create the index in that branch at project root and update the helm install section in README

@leakingtapan
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 25, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kferrone, leakingtapan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 25, 2020
@k8s-ci-robot k8s-ci-robot merged commit 6d37460 into kubernetes-sigs:master Jun 25, 2020
@jqmichael
Copy link
Contributor

Thx for creating the helm index! I will move the file to github page in a separate branch and make it public once this is merged.

Just curious, what's the benefit of using a separate branch vs keeping it at master?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish Helm Chart to Repo
4 participants