Commit Graph

140 Commits

Author SHA1 Message Date
CarlosPet 17953061c4 Added AWS documentation in Kubernetes Authentication Documentation (#19588)
* Added AWS documentation in Kubernetes Authentication Documentation

I included instructions on how to configure the AWS server side authentication while using the Kubernetes plug-in.

Signed-off-by: Carlos Inocencio <carlos.inocencio@petco.com>

* Update authentication.md

Updated `aws` reference to use in-line code blocks to avoid triggering an error in the code checks

Signed-off-by: Carlos Inocencio <carlos.inocencio@petco.com>

---------

Signed-off-by: Carlos Inocencio <carlos.inocencio@petco.com>
2023-09-05 14:00:12 +00:00
Jamie Klassen 26fde684d6 Add caveats about production-suitability
Also restructure the token instructions into a bullet list based on k8s version.

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-07-20 22:29:27 -04:00
Jamie Klassen 7cb2217599 improve serviceAccountToken docs
Give instructions for k8s 1.24+, and mention the in-cluster option

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-07-05 13:02:51 -04:00
Jamie Klassen c7bad1005b add aks access token to request body
Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-05-08 10:04:58 -04:00
Andre Wanlin 3d809a66bf Changes based on feedback
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-04-14 12:39:23 -05:00
Andre Wanlin 90b157c999 Removed running-backstage-locally.md
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-04-12 14:31:26 -05:00
Ruben Vallejo c159ab64a6 add changeset and docs
Signed-off-by: Ruben Vallejo <rvallejo@vmware.com>
2023-04-04 12:22:58 -04:00
Ruben Vallejo a3439ddac5 update proxy docs
Signed-off-by: Ruben Vallejo <rvallejo@vmware.com>
2023-03-29 17:20:41 -04:00
Ruben Vallejo 7c4cf78bd8 Add disable proxy endpoint section to docs
Signed-off-by: Ruben Vallejo <rvallejo@vmware.com>
2023-03-16 11:51:18 -04:00
Ruben Vallejo c04498db27 Refactor header names, add options object to requestHandler and add new changes to api-reports and changeset along with docs
Signed-off-by: Ruben Vallejo <rvallejo@vmware.com>
2023-03-16 11:51:17 -04:00
Ruben Vallejo a711ad54da Revert kubernetes create and read permissions to singular proxy permission, reword changeset, add permission parameter to install doc
Signed-off-by: Ruben Vallejo <rvallejo@vmware.com>
2023-03-16 11:51:17 -04:00
Paul Schultz 040b54f7e5 clean up formatting
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-08 10:13:38 -06:00
Paul Schultz 34fe6c9246 Merge branch 'master' into update-codeblocks 2023-03-08 10:07:11 -06:00
Paul Schultz 9c95f91c0a Add titles to codeblocks and switch from diff codeblock to language codeblock
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-01 13:30:38 -06:00
Jamie Klassen 8adeb19b37 GitLab is an oidcTokenProvider
Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-02-28 12:48:46 -05:00
Jamie Klassen 7126b48d6a update known issues since #16018 was fixed
Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-02-08 13:31:49 -05:00
Jamie Klassen 05c26fd475 remove relative links
Otherwise, `scripts/verify-links.js` will fail.

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-02-08 13:28:21 -05:00
Jamie Klassen a53d06afe5 Document the proxy endpoint
Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2023-02-08 13:28:20 -05:00
Ben Lambert 834ac839b4 Update docs/features/kubernetes/configuration.md
Signed-off-by: Ben Lambert <blam@spotify.com>
2023-01-24 10:53:04 +01:00
Mengnan Gong c59a5e114a Improve the Kubernetes plugin documentation
- Add the `objectTypes` config
- Add the access needed to fetch pod metrics in the RBAC chapter

Signed-off-by: Mengnan Gong <namco1992@gmail.com>
2023-01-16 18:36:52 +08:00
Jamie Klassen 22e20b3a59 clusters in app-config support caFile
Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2022-12-02 18:23:18 -05:00
Harry Powell c72c6172db Correct kubernetes.ts file path in installation.md
Correcting file path from `packages/backend/src/plugin/kubernetes.ts` to `packages/backend/src/plugins/kubernetes.ts`

Signed-off-by: Harry Powell <powell.harryj@gmail.com>
2022-11-14 14:18:18 +00:00
Fredrik Adelöw cbe11d1e23 just getting rid of vale warnings
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-10-22 17:18:47 +02:00
Jamie Klassen 7218a2b0ab fix localKubectlProxy link
the anchors for subheadings generated from this markdown are always lowercase, so this link wasn't working before

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2022-10-06 15:03:01 -04:00
Fredrik Adelöw c01d7a692e Merge pull request #13796 from luchillo17/feat/BCKSTG-65
docs: Add disclaimer about OIDC enabled clusters
2022-09-27 11:37:30 +02:00
Carlos Esteban Lopez 9847aef033 docs: Change GKE for EKS in oidcTokenProvider section
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-09-21 15:50:06 -05:00
Carlos Esteban Lopez 7e4bffe0b8 docs: Add disclaimer about OIDC enabled clusters
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-09-21 14:53:57 -05:00
ivgo b6d01e9a78 Added missing daemonsets to RBAC permissions
Signed-off-by: ivgo <ivgo@spreadgroup.com>
2022-09-21 11:45:30 +02:00
Patrik Oldsberg 6ddfcd4d9d Update docs/features/kubernetes/authentication.md
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-09-20 23:54:53 +02:00
Carlos Esteban Lopez 92eb5690a9 docs: Address MR comments
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-09-20 10:28:29 -05:00
Carlos Esteban Lopez Jaramillo 16f66c8a51 Update docs/features/kubernetes/authentication.md
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-09-20 10:28:29 -05:00
Carlos Esteban Lopez f32117268f docs: Mention AKS AAD requirement
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-09-20 10:28:29 -05:00
Carlos Esteban Lopez cc05706f35 docs: Address MR comments
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-09-20 10:28:29 -05:00
Carlos Esteban Lopez Jaramillo d12ebdde77 Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-09-20 10:28:29 -05:00
Carlos Esteban Lopez 0df43e5893 docs: Add kubernetes azure auth provider section
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-09-20 10:28:29 -05:00
Carlos Esteban Lopez a0180e7889 docs: Improve authentication explanation for kubernetes plugin
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-08-31 11:11:00 -05:00
Carlos Esteban Lopez Jaramillo 4f78263768 docs: Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 17:12:28 -05:00
Carlos Esteban Lopez Jaramillo ccb891fb86 docs: Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 17:11:57 -05:00
Carlos Esteban Lopez Jaramillo 60a9f41b6e docs: Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 16:53:18 -05:00
Carlos Esteban Lopez Jaramillo 37d6360844 docs: Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 16:52:55 -05:00
Carlos Esteban Lopez Jaramillo b654a3d5be docs: Update docs/features/kubernetes/configuration.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 16:48:25 -05:00
Carlos Esteban Lopez Jaramillo 0823dd0203 docs: Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 16:47:22 -05:00
Carlos Esteban Lopez c0531dd10f docs: Remove changeset & docs changes
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-08-30 10:10:27 -05:00
Carlos Esteban Lopez Jaramillo 9b11c25661 docs: Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 09:59:12 -05:00
Carlos Esteban Lopez Jaramillo 97542dca4b docs: Update docs/features/kubernetes/authentication.md
Co-authored-by: Jamie Klassen <jklassen@vmware.com>
Signed-off-by: Carlos Esteban Lopez Jaramillo <luchillo17@gmail.com>
2022-08-30 09:55:27 -05:00
Carlos Esteban Lopez 0058d27517 docs: Add section for Kuberentes plugin Auth
Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
2022-08-29 14:04:31 -05:00
Andres Mauricio Gomez P 9a0930e6d1 Kubernetes docs changed to show the new customResources property at the clusters level
Signed-off-by: Andres Mauricio Gomez P <andmagom@outlook.com>
2022-08-03 12:11:40 -05:00
Jamie Klassen c51d970410 clarify caData field
The code in `@kubernetes/client-node` will decode this value, as seen here:

https://github.com/kubernetes-client/javascript/blob/2b6813f99a85605f691973d6bc43f291ac072fc7/src/config.ts#L518-L520

I have seen a casual reader insert the multi-line raw contents of a PEM file in
this field, so it seems worth mentioning the extra layer of encoding explicitly.

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2022-07-29 15:38:32 -04:00
Lucas Teligioridis 3f35423e3c Add instructions to prevent 403 on API read
The latest plugin requires a the "limitranges" API to be available for
read-only otherwise a 403 error will return on the Kubernetes pane.

Signed-off-by: Lucas Teligioridis <lucas@teligioridis.dev>
2022-07-27 08:10:29 +10:00
Lucas Teligioridis 8524931589 Provide clearer documentation on correct permissions
Rather than providing the objects and what permissions are required,
just provide a valid Kubernetes manifest that clearly shows this to the
developer setting this up. Will also prevent any ambiguity when applying
this directly against a Kubernetes API.

Signed-off-by: Lucas Teligioridis <lucas@teligioridis.dev>
2022-07-22 22:37:47 +10:00