-
Notifications
You must be signed in to change notification settings - Fork 12
[DO NOT MERGE YET] Staging-2.12. Should be merged when rancher 2.12 is released (RBAC mostly) #41
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
Open
craffit
wants to merge
10
commits into
staging
Choose a base branch
from
staging-2.12
base: staging
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
a624e66
Reapply "STAC-22208: document Kubernetes/Rancher RBAC and the new per…
craffit e93cc1f
STAC-22990: Document describe subjects and the meaning of the field.…
aacevedoosorio 14dd159
Merge pull request #42 from aacevedoosorio/stac-22990
aacevedoosorio a2035ba
Prefer the use of service tokens over api keys
fvlankvelt 36e3698
add example of scoped permission for data ingestion
fvlankvelt ebad1be
Merge pull request #44 from fvlankvelt/prefer-service-token
fvlankvelt 4446864
STAC-23049: describe user-session roles commamnd
fvlankvelt 10d83db
Merge pull request #49 from fvlankvelt/STAC-23049-describe-user-sessi…
fvlankvelt c541974
STAC-22956: document how to add observability as a data source to gra…
fvlankvelt e3e45b0
Merge pull request #50 from fvlankvelt/STAC-22956-document-grafana
fvlankvelt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,9 +18,38 @@ The result of this configuration should produce a *clientId* and a *secret*. Cop | |
|
||
== Configure SUSE Observability for OIDC | ||
|
||
=== Rancher | ||
|
||
To configure Rancher as the OIDC provider for SUSE Observability, you need to add the OIDC details to the authentication values: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Document here that this only works with rancher 2.12 |
||
[,yaml] | ||
---- | ||
stackstate: | ||
authentication: | ||
rancher: | ||
clientId: "<oidc-client-id>" | ||
secret: "<oidc-secret>" | ||
baseUrl: "<rancher-url>" | ||
---- | ||
You can override and extend the OIDC config for Rancher with the following fields: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cross-link with rancher docs: rancher/rancher-docs#1844 |
||
|
||
* **discoveryUri** - URI that you can use to discover the OIDC provider. Normally, also documented or returned when creating the client in the OIDC provider. | ||
* **redirectUri** - Optional (not in the example): The URI where the login callback endpoint of SUSE Observability is reachable. Populated by default using the `stackstate.baseUrl`, but can be overridden. This must be a fully qualified URL that points to the `/loginCallback` path. | ||
* **customParameters** - Optional map of key/value pairs that you send to the OIDC provider as custom request parameters. Certain OIDC providers require extra request parameters not sent by default. | ||
|
||
If you need to disable TLS verification due to a setup not using verifiable SSL certificates, you can disable SSL checks with application config (don't use in production): | ||
[,yaml] | ||
---- | ||
stackstate: | ||
components: | ||
server: | ||
extraEnv: | ||
open: | ||
CONFIG_FORCE_stackstate_misc_sslCertificateChecking: false | ||
---- | ||
|
||
=== Kubernetes | ||
|
||
To configure SUSE Observability to use an OIDC authentication provider on Kubernetes, OIDC details and user role mapping needs to be added to the file `authentication.yaml`. For example: | ||
To configure SUSE Observability to use an OIDC authentication provider on Kubernetes, you need to add OIDC details and user role mapping to the file `authentication.yaml`. For example: | ||
|
||
[,yaml] | ||
---- | ||
|
31 changes: 31 additions & 0 deletions
31
docs/next/modules/en/pages/setup/security/rbac/README.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,33 @@ | ||
= Role based access control (RBAC) | ||
:description: SUSE Observability Self-hosted | ||
|
||
Access Management helps you manage who has access to the specific topology elements, metric data, traces, UI elements, and which APIs they can call. | ||
|
||
RBAC is an authorization system that provides fine-grained access management of SUSE Observability resources, a clean and easy way to audit user privileges and to fix identified issues with access rights. | ||
|
||
== What can you do with RBAC? | ||
|
||
Here are examples of what you can do with RBAC: | ||
|
||
* Allow one user to have access to the development cluster only, another one to both the production and development cluster and a third can access the development cluster and only 1 namespace in the production cluster. | ||
* Give a small group of users an administrator role to setup and configure SUSE Observability. While giving all developers a troubleshooter role to view all topology, metrics, traces, logs and events, but with limited configuration capability. | ||
|
||
== What's a role in SUSE Observability? | ||
|
||
A role in SUSE Observability is a combination of a configured subject and a set of xref:/setup/security/rbac/rbac_permissions.adoc[permissions]. Process of setting up a role in SUSE Observability is described in xref:/setup/security/rbac/rbac_roles.adoc[How to set up roles]. | ||
|
||
== Sources of RBAC roles | ||
|
||
You can define roles in several ways. All use the same xref:/setup/security/rbac/rbac_permissions.adoc[Permissions]. | ||
|
||
* **Configuration** - in the xref:setup/security/rbac/rbac_roles.adoc#_custom_roles_via_the_configuration_file[helm values] for SUSE Observability | ||
* **Dynamic** - xref:setup/security/rbac/rbac_roles.adoc#_custom_roles_via_the_cli[use the `sts` CLI] | ||
* **Mapped from Kubernetes** - xref:/setup/security/rbac/rbac_rancher.adoc[map Kubernetes `Roles` and `RoleBindings`] | ||
|
||
== More on RBAC configuration | ||
|
||
* xref:/setup/security/rbac/rbac_permissions.adoc[Permissions] | ||
* xref:/setup/security/rbac/rbac_roles.adoc[How to set up roles] | ||
* xref:/setup/security/rbac/rbac_rancher.adoc[Use with Rancher] | ||
* xref:/setup/security/rbac/rbac_scopes.adoc[Scopes] | ||
* xref:/setup/security/authentication/README.adoc[How to configure authentication] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: Add additional documentation to rancher prime install to setup OIDC when RBAC is required.