From 24b0e61cef92e3dc9c10767fe0512cffe7fb1231 Mon Sep 17 00:00:00 2001 From: Matthew <133825715+mattLif@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:39:02 -0500 Subject: [PATCH] Moved Plugins to a Folder And Fixed All Linking to Them Signed-off-by: Matthew <133825715+mattLif@users.noreply.github.com> --- docs/config-tornjak-server.md | 8 ++++---- docs/index.md | 10 +++++----- .../plugin_server_authentication_keycloak.md | 0 docs/{ => plugins}/plugin_server_authorization_rbac.md | 0 docs/{ => plugins}/plugin_server_datastore_sql.md | 0 docs/{ => plugins}/plugin_server_spirecrd.md | 0 docs/user-management.md | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) rename docs/{ => plugins}/plugin_server_authentication_keycloak.md (100%) rename docs/{ => plugins}/plugin_server_authorization_rbac.md (100%) rename docs/{ => plugins}/plugin_server_datastore_sql.md (100%) rename docs/{ => plugins}/plugin_server_spirecrd.md (100%) diff --git a/docs/config-tornjak-server.md b/docs/config-tornjak-server.md index 56782e44..4e1f6d38 100644 --- a/docs/config-tornjak-server.md +++ b/docs/config-tornjak-server.md @@ -83,10 +83,10 @@ Tornjak supports several different plugin types, each representing a different f | Type | Name | Description | | ---- | ---- | ----------- | -| DataStore | SQL | Default SQL storage for Tornjak metadata | -| SPIRECRDManager | [""](/docs/plugin_server_spirecrd.md) | CRD Manager | -| Authenticator | [keycloak](/docs/plugin_server_authentication_keycloak.md) | Perform OIDC Discovery and extract roles from `realmAccess.roles` field | -| Authorizer | [RBAC](/docs/plugin_server_authorization_rbac.md) | Check api permission based on user role and defined authorization logic | +| DataStore | ["SQL"](/docs/plugins/plugin_server_datastore_sql.md) | Default SQL storage for Tornjak metadata | +| SPIRECRDManager | ["SpireCRD"](/docs/plugins/plugin_server_spirecrd.md) | CRD Manager | +| Authenticator | [keycloak](/docs/plugins/plugin_server_authentication_keycloak.md) | Perform OIDC Discovery and extract roles from `realmAccess.roles` field | +| Authorizer | [RBAC](/docs/plugins/plugin_server_authorization_rbac.md) | Check api permission based on user role and defined authorization logic | ### Plugin configuration diff --git a/docs/index.md b/docs/index.md index 5346b0e2..7bda5797 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,19 +3,19 @@ - [Blogs](/docs/blogs.md) - [Debugging, Hints and Tips for Solving Common Problems with Tornjak](/docs/tornjak-hints.md) - - [Tornjak Deployment](docs/tornjak-hints.md#tornjak-deployment) + - [Tornjak Deployment](/docs/tornjak-hints.md#tornjak-deployment) - [Tornjak Configuration](/docs/tornjak-hints.md#tornjak-configuration) - [User Management](/docs/tornjak-hints.md#user-management) - [JSON Format for New Entry](/docs/newEntry-json-format.md) -- [Server plugin: Authentication "Keycloak"](/docs/plugin_server_authentication_keycloak.md) +- [Server plugin: Authentication "Keycloak"](/docs/plugins/plugin_server_authentication_keycloak.md) -- [Server plugin: Authorization "RBAC"](/docs/plugin_server_authorization_rbac.md) +- [Server plugin: Authorization "RBAC"](/docs/plugins/plugin_server_authorization_rbac.md) -- [Server plugin: Datastore "SQL"](/docs/plugin_server_datastore_sql.md) +- [Server plugin: Datastore "SQL"](/docs/plugins/plugin_server_datastore_sql.md) -- [Server plugin: SPIRECRDManager](/docs/plugin_server_spirecrd.md) +- [Server plugin: SPIRECRDManager](/docs/plugins/plugin_server_spirecrd.md) - [Tornjak Agent](/docs/tornjak-agent.md) - [Tornjak SPIRE Server Agent](/docs/tornjak-agent.md#tornjak-spire-server-agent) diff --git a/docs/plugin_server_authentication_keycloak.md b/docs/plugins/plugin_server_authentication_keycloak.md similarity index 100% rename from docs/plugin_server_authentication_keycloak.md rename to docs/plugins/plugin_server_authentication_keycloak.md diff --git a/docs/plugin_server_authorization_rbac.md b/docs/plugins/plugin_server_authorization_rbac.md similarity index 100% rename from docs/plugin_server_authorization_rbac.md rename to docs/plugins/plugin_server_authorization_rbac.md diff --git a/docs/plugin_server_datastore_sql.md b/docs/plugins/plugin_server_datastore_sql.md similarity index 100% rename from docs/plugin_server_datastore_sql.md rename to docs/plugins/plugin_server_datastore_sql.md diff --git a/docs/plugin_server_spirecrd.md b/docs/plugins/plugin_server_spirecrd.md similarity index 100% rename from docs/plugin_server_spirecrd.md rename to docs/plugins/plugin_server_spirecrd.md diff --git a/docs/user-management.md b/docs/user-management.md index 7ea2226e..6b7cf6e8 100644 --- a/docs/user-management.md +++ b/docs/user-management.md @@ -43,7 +43,7 @@ Once the Auth Server is set up, we can deploy the Tornjak Backend to require acc as detailed in [this followup Medium blog](https://medium.com/universal-workload-identity/guide-to-integrating-tornjak-with-keycloak-for-access-control-to-spire-40a3d5ee5f5a), with more details on the general configuration -[here](/docs/config-tornjak-server.md). Most notably, populate a new plugin section for keycloak as defined [here](/docs/plugin_server_auth_keycloak.md) like so: +[here](/docs/config-tornjak-server.md). Most notably, populate a new plugin section for keycloak as defined [here](/docs/plugins/plugin_server_auth_keycloak.md) like so: ``` ...