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: explain SA automounting & autoconf #5644

Closed
wants to merge 0 commits into from
Closed

Conversation

badp
Copy link
Contributor

@badp badp commented Dec 14, 2023

Description

Add a few words about how the client automatically attempts to pick up authentication credentials and other information about a cluster directly from Kubernetes, and what to do if that's not what you want.

This is a follow-up to this conversation on gitter:
https://matrix.to/#/!rDlRZKYupRPQnkjTvm:gitter.im/$xrYokOTFaI1N4Q1xRSHMGlJ5v68VGy-piWTXuFrFmJ4?via=gitter.im&via=matrix.org

With many thanks to Rohan Kumar.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change
  • Chore (non-breaking change which doesn't affect codebase;
    test, version modification, documentation, etc.)

Checklist

  • Code contributed by me aligns with current project license: Apache 2.0
  • I Added CHANGELOG entry regarding this change
  • I have implemented unit tests to cover my changes
  • I have added/updated the javadocs and other documentation accordingly
  • No new bugs, code smells, etc. in SonarCloud report
  • I tested my code in Kubernetes
  • I tested my code in OpenShift

@badp badp marked this pull request as ready for review December 14, 2023 11:05
README.md Outdated
@@ -72,7 +72,7 @@ System properties are preferred over environment variables. The following system

| Property / Environment Variable | Description | Default value |
|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| `kubernetes.disable.autoConfig` / `KUBERNETES_DISABLE_AUTOCONFIG` | Disable automatic configuration | `false` |
| `kubernetes.disable.autoConfig` / `KUBERNETES_DISABLE_AUTOCONFIG` | Disable automatic configuration (cluster, networking and authentication configuration, including all other entries in this table) | `false` |
Copy link
Member

Choose a reason for hiding this comment

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

Umm, I think we need to reword it a little. I think this property turns off KubernetesClient's behavior to look for cluster-related configuration in well-known sources.

@manusa manusa added the Waiting on feedback Issues that require feedback from User/Other community members label Dec 19, 2023
@rohanKanojia
Copy link
Member

@badp : Sorry, I accidentally closed your pull request by force pushing to your fork's main branch.

I've created a new pull request by cherry-picking your commit there #5748

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Waiting on feedback Issues that require feedback from User/Other community members
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants