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

Update description of kubeconfig specific flag #4226

Merged
merged 1 commit into from
Sep 18, 2023

Conversation

somtochiama
Copy link
Member

@somtochiama somtochiama commented Sep 8, 2023

The --insecure-skip-tls-verify, --certificate-authority, client-key and client-certificate are kubeconfig flags that are used when connecting to the Kubernetes API Server. The generic description sometimes makes users assume that this is for something else e.g see comment

Though I have the option --insecure-skip-tls-verify , still getting certifcate error.

This pull request updates the description to be clear about which server it is used for.
Before

--insecure-skip-tls-verify               If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--certificate-authority string           Path to a cert file for the certificate authority
--client-certificate string              Path to a client certificate file for TLS
--client-key string                      Path to a client key file for TLS

After

--insecure-skip-tls-verify       If true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--certificate-authority string   Path to a cert file for the certificate authority to authenticate Kubernetes API
--client-certificate string      Path to a client certificate file for TLS authentication to Kubernetes API
--client-key string              Path to a client key file for TLS authentication to Kubernetes API

@stefanprodan
Copy link
Member

stefanprodan commented Sep 8, 2023

I propose we do the same for:

      --certificate-authority string   Path to a cert file for the certificate authority
      --client-certificate string      Path to a client certificate file for TLS
      --client-key string              Path to a client key file for TLS

@stefanprodan stefanprodan added the area/ux In pursuit of a delightful user experience label Sep 8, 2023
@somtochiama somtochiama changed the title Update description of --insecure-skip-tls-verify flag Update description of kubeconfig specific flag Sep 8, 2023
Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

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

LGTM!

@stefanprodan stefanprodan mentioned this pull request Sep 18, 2023
18 tasks
@stefanprodan stefanprodan added the backport:release/v2.1.x To be backported to release/v2.1.x label Sep 18, 2023
Signed-off-by: Somtochi Onyekwere <somtochionyekwere@gmail.com>
@somtochiama somtochiama force-pushed the update-kubeconfig-flag branch from 4879303 to 1654791 Compare September 18, 2023 09:48
@stefanprodan stefanprodan merged commit ebace98 into fluxcd:main Sep 18, 2023
7 checks passed
@fluxcdbot
Copy link
Member

Successfully created backport PR for release/v2.1.x:

nrdufour added a commit to nrdufour/home-ops that referenced this pull request Oct 3, 2023
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [fluxcd/flux2](https://github.com/fluxcd/flux2) | Kustomization | patch | `v2.1.0` -> `v2.1.1` |

---

### Release Notes

<details>
<summary>fluxcd/flux2 (fluxcd/flux2)</summary>

### [`v2.1.1`](https://github.com/fluxcd/flux2/releases/tag/v2.1.1)

[Compare Source](fluxcd/flux2@v2.1.0...v2.1.1)

#### Highlights

Flux `v2.1.1` is a patch release which comes with various fixes. Users are encouraged to upgrade for the best experience.

##### Fixes

-   Use auto lookup strategy for Buckets to widen support for S3-compatible object storage services (`source-controller`).
-   Fix Secret type check for HelmRepositories TLS certs referred in `.spec.secretRef` (`source-controller`).
-   Fix the branch name reporting when the push branch is the same as the checkout branch (`image-automation-controller`).
-   Restore Helm logs inclusion in failure events (`helm-controller`).
-   Fix the impersonation of the default service account when diffing HelmReleases (`helm-controller`).
-   Check source for `nil` artifact before loading Helm charts (`helm-controller`).
-   Update the description of Kubernetes specific flag to distinguish them from Flux bootstrap flags (`flux` CLI).

#### Components changelog

-   source-controller [v1.1.1](https://github.com/fluxcd/source-controller/blob/v1.1.1/CHANGELOG.md)
-   helm-controller [v0.36.1](https://github.com/fluxcd/helm-controller/blob/v0.36.1/CHANGELOG.md)
-   image-automation-controller [v0.36.1](https://github.com/fluxcd/image-automation-controller/blob/v0.36.1/CHANGELOG.md)

#### CLI Changelog

-   PR [#&#8203;4255](fluxcd/flux2#4255) - [@&#8203;hiddeco](https://github.com/hiddeco) - tests/azure: update controller dependencies
-   PR [#&#8203;4251](fluxcd/flux2#4251) - [@&#8203;fluxcdbot](https://github.com/fluxcdbot) - Update toolkit components
-   PR [#&#8203;4246](fluxcd/flux2#4246) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump the ci group with 4 updates
-   PR [#&#8203;4238](fluxcd/flux2#4238) - [@&#8203;makkes](https://github.com/makkes) - Upgrade github.com/fluxcd/pkg/{git,git/gogit}
-   PR [#&#8203;4233](fluxcd/flux2#4233) - [@&#8203;sonbui00](https://github.com/sonbui00) - chore: remove support armv6h for aur package
-   PR [#&#8203;4228](fluxcd/flux2#4228) - [@&#8203;sonbui00](https://github.com/sonbui00) - Improve AUR package templates
-   PR [#&#8203;4227](fluxcd/flux2#4227) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump the ci group with 3 updates
-   PR [#&#8203;4226](fluxcd/flux2#4226) - [@&#8203;somtochiama](https://github.com/somtochiama) - Update description of kubeconfig specific flag
-   PR [#&#8203;4222](fluxcd/flux2#4222) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump github.com/cyphar/filepath-securejoin from 0.2.3 to 0.2.4 in /tests/integration
-   PR [#&#8203;4221](fluxcd/flux2#4221) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump github.com/cyphar/filepath-securejoin from 0.2.3 to 0.2.4 in /tests/azure
-   PR [#&#8203;4215](fluxcd/flux2#4215) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump the ci group with 4 updates
-   PR [#&#8203;4213](fluxcd/flux2#4213) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump github.com/docker/distribution from 2.8.1+incompatible to 2.8.2+incompatible in /tests/integration
-   PR [#&#8203;4212](fluxcd/flux2#4212) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump github.com/docker/docker from 23.0.1+incompatible to 23.0.3+incompatible in /tests/integration
-   PR [#&#8203;4198](fluxcd/flux2#4198) - [@&#8203;makkes](https://github.com/makkes) - Add 2.1.x backport label
-   PR [#&#8203;4197](fluxcd/flux2#4197) - [@&#8203;stefanprodan](https://github.com/stefanprodan) - Fix links to fluxcd.io
-   PR [#&#8203;4195](fluxcd/flux2#4195) - [@&#8203;dependabot](https://github.com/dependabot)\[bot] - build(deps): bump the ci group with 2 updates

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi45Ni4wIiwidXBkYXRlZEluVmVyIjoiMzYuOTYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Reviewed-on: https://git.home/nrdufour/home-ops/pulls/94
Co-authored-by: Renovate <renovate@ptinem.io>
Co-committed-by: Renovate <renovate@ptinem.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ux In pursuit of a delightful user experience backport:release/v2.1.x To be backported to release/v2.1.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants