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

docs: describe how to use podman with kind #202

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

sudomateo
Copy link
Contributor

This patch adds a section to the README describing how to use Podman with cloud-provider-kind. Podman does not allow sharing the host networking or binding to privileged ports so the -enable-lb-port-mapping option can be used to get an ephemeral port on the host that maps to the LoadBalancer listening port.

Copy link

linux-foundation-easycla bot commented Jan 26, 2025

CLA Signed


The committers listed above are authorized under a signed CLA.

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

Welcome @sudomateo!

It looks like this is your first PR to kubernetes-sigs/cloud-provider-kind 🎉. 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/cloud-provider-kind 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 Jan 26, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @sudomateo. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 26, 2025
Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

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

Thanks for proposing this! We do need a signed CLA before anything can be accepted into the project. Please see the bot comment above and let us know if you have any questions.

running as root, which is not recommended.

To connect to your service when using Podman, run `cloud-provider-kind` with the
`-enable-lb-port-mapping` option. This configures the Envoy container with an
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
`-enable-lb-port-mapping` option. This configures the Envoy container with an
`--enable-lb-port-mapping` option. This configures the Envoy container with an

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The --help option lists the options with a single dash. That's the only reason I used it that way. Happy to change though.

> cloud-provider-kind --help
Usage: cloud-provider-kind [options]

  -enable-lb-port-mapping
        enable port-mapping on the load balancer ports
  -enable-log-dumping
        store logs to a temporal directory or to the directory specified using the logs-dir flag
  -logs-dir string
        store logs to the specified directory
  -v int
        Verbosity level (default 2)

@sudomateo
Copy link
Contributor Author

sudomateo commented Jan 26, 2025

CLA Not Signed

* [❌](https://api.easycla.lfx.linuxfoundation.org/v2/repository-provider/github/sign/20677499/609171582/202/#/?version=2) - login: @sudomateo / name: Matthew Sanabria . The commit ([0f17d76](https://github.com/kubernetes-sigs/cloud-provider-kind/commit/0f17d7675a11801fe57114b80b95c0dd4c7ba610)) is not authorized under a signed CLA. [Please click here to be authorized](https://api.easycla.lfx.linuxfoundation.org/v2/repository-provider/github/sign/20677499/609171582/202/#/?version=2). For further assistance with EasyCLA, [please submit a support request ticket](https://jira.linuxfoundation.org/servicedesk/customer/portal/4).

I'm fine with signing a CLA but I don't feel comfortable listing my address in the Docusign when I don't know who has access to it. This is a documentation contribution, not code. I'm happy to relinquish whatever rights so that the kubernetes-sigs organization owns this contribution. Sorry, I don't mean to be difficult here but this feels a bit excessive.

Screenshot 2025-01-26 at 10-42-52 Review and sign document(s) Docusign

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@aojea
Copy link
Contributor

aojea commented Jan 26, 2025

I'm fine with signing a CLA but I don't feel comfortable listing my address in the Docusign when I don't know who has access to it. This is a documentation contribution, not code. I'm happy to relinquish whatever rights so that the kubernetes-sigs organization owns this contribution. Sorry, I don't mean to be difficult here but this feels a bit excessive.

I don't really know how this work, AFAIK these are Linux Foundation policies ... I really don't know what fields are mandatory and what are optional, maybe you can skip filling in those?

This patch adds a section to the README describing how to use
Podman with `cloud-provider-kind`. Podman does not allow sharing
the host networking or binding to privileged ports so the
`-enable-lb-port-mapping` option can be used to get an ephemeral port on
the host that maps to the `LoadBalancer` listening port.
@sudomateo sudomateo force-pushed the podman-documentation branch from 0f17d76 to f7f01bf Compare January 26, 2025 17:40
@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 Jan 26, 2025
@sudomateo
Copy link
Contributor Author

I don't really know how this work, AFAIK these are Linux Foundation policies ... I really don't know what fields are mandatory and what are optional, maybe you can skip filling in those?

I used N/A for the address fields. CLA is signed.

@aojea
Copy link
Contributor

aojea commented Jan 26, 2025

/ok-to-test
/approve

defer LGTM to @stmcginnis
/assign @stmcginnis

Thanks

@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. approved Indicates a PR has been approved by an approver from all required OWNERS files. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 26, 2025
@BenTheElder
Copy link
Member

The CNCF runs the CLA system and ultimately owns the copyright, trademarks etc, so we're just required to use it for kubernetes repos. (Some newer CNCF projects use DCO, but not the Kubernetes org).

FWIW they do have a help desk listed here: https://github.com/cncf/cla#troubleshooting

@BenTheElder
Copy link
Member

AFAIK, the database is private to the linux foundation and nobody in the Kubernetes project can see it (not even the steering committee), my understanding is that it exists so CNCF/LF legal can reach out if needed, but I don't know who exactly has access.

@jeefy is this documented anywhere?

@aojea
Copy link
Contributor

aojea commented Jan 28, 2025

let's merge, this is very useful documentation as it is a very hard to explain feature
/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aojea, sudomateo

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 merged commit defae81 into kubernetes-sigs:main Jan 28, 2025
7 checks passed
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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants