From ed94078ba67db3a60982f31ea99e9f4e403bc8f0 Mon Sep 17 00:00:00 2001 From: Matthew <133825715+mattLif@users.noreply.github.com> Date: Tue, 19 Nov 2024 16:53:37 -0500 Subject: [PATCH 1/5] Created Index Page for Docs Signed-off-by: Matthew <133825715+mattLif@users.noreply.github.com> --- docs/index.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..83e77ba1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,64 @@ +# Index + +- [Blogs](https://github.com/spiffe/tornjak/blob/main/docs/blogs.md) + +- [Debugging, Hints and Tips for Solving Common Problems with Tornjak](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md) + - [Tornjak Deployment](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-deployment) + - [Tornjak Configuration](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-configuration) + - [User Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#user-management) + +- [JSON Format for New Entry](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) + +- [Server plugin: Authentication "Keycloak"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authentication_keycloak.md) + +- [Server plugin: Authorization "RBAC"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authorization_rbac.md) + +- [Server plugin: Datastore "SQL"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_datastore_sql.md) + +- [Server plugin: SPIRECRDManager](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_spirecrd.md) + +- [Tornjak Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md) + - [Tornjak SPIRE Server Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#tornjak-spire-server-agent) + - [APIs](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#apis) + - [Authentication](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authentication) + - [Authorization](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authorization) + +- [Tornjak Manager](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md) + - [Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#global-visibility) + - [Identity Policy Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#identity-policy-management) + - [Auditability of Identities And Use For Operations/Forensics](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#auditability-of-identities-and-use-for-operationsforensics) + - [Management of SPIRE Identity Configurations](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#management-of-spire-identity-configurations) + +- [Tornjak Plan](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) + - [Milestone A: Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-a-global-visibility) + - [Milestone B: Global Visibility + Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-b-global-visibility--authentication) + - [Milestone C: Policy management](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-c-policy-management) + - [Milestone D: Improve Policy definitions and UX](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-d-improve-policy-definitions-and-ux) + - [Milestone E: Auditability](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-e-auditability) + - [Milestone F: Advanced Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-f-advanced-authentication) + - [Milestone G: Enhancing SPIRE API](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-g-enhancing-spire-api) + +- [Tornjak Server Configuration Reference](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md) + - [Command line options](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#command-line-options) + - [The Tornjak Config](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#the-tornjak-config) + - [General Tornjak Server Configs](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#general-tornjak-server-configs) + - [About Tornjak Plugins](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#about-tornjak-plugins) + - [Sample Configuration Files](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#sample-configuration-files) + - [Further Reading](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#further-reading) + +- [Tornjak UI-API Documentation](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md) + - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#11-overview) + - [Tornjak User Interface (UI) Architecture](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture) + - [UI Pages (With their paths)](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths) + - [Tornjak User Interface (UI) Interaction with API Endpoints](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints) + - [Agent API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#31-tornjak-apis) + - [Manager API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#32-manager-apis) + - [Tornjak Redux Reducers and Actions With Their Respective Descriptions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions) + - [Reducers](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#41-reducers) + - [Actions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#42-actions) + +- [User Management](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md) + - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#overview) + - [Architecture](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#architecture) + - [General Deployment](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#general-deployment) + - [Examples and Tutorials](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#examples-and-tutorials) \ No newline at end of file From 48b984042a6a0c4c75e25870951513da3089740b Mon Sep 17 00:00:00 2001 From: Matthew <133825715+mattLif@users.noreply.github.com> Date: Thu, 21 Nov 2024 14:34:24 -0500 Subject: [PATCH 2/5] Lint Fix Signed-off-by: Matthew <133825715+mattLif@users.noreply.github.com> --- docs/index.md | 100 +++++++++++++++++++++++++------------------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/docs/index.md b/docs/index.md index 83e77ba1..768a1eba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,64 +1,64 @@ # Index -- [Blogs](https://github.com/spiffe/tornjak/blob/main/docs/blogs.md) +- [Blogs](https://github.com/spiffe/tornjak/blob/main/docs/blogs.md) -- [Debugging, Hints and Tips for Solving Common Problems with Tornjak](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md) - - [Tornjak Deployment](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-deployment) - - [Tornjak Configuration](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-configuration) - - [User Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#user-management) +- [Debugging, Hints and Tips for Solving Common Problems with Tornjak](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md) + - [Tornjak Deployment](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-deployment) + - [Tornjak Configuration](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-configuration) + - [User Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#user-management) -- [JSON Format for New Entry](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) +- [JSON Format for New Entry](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) -- [Server plugin: Authentication "Keycloak"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authentication_keycloak.md) +- [Server plugin: Authentication "Keycloak"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authentication_keycloak.md) -- [Server plugin: Authorization "RBAC"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authorization_rbac.md) +- [Server plugin: Authorization "RBAC"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authorization_rbac.md) -- [Server plugin: Datastore "SQL"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_datastore_sql.md) +- [Server plugin: Datastore "SQL"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_datastore_sql.md) -- [Server plugin: SPIRECRDManager](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_spirecrd.md) +- [Server plugin: SPIRECRDManager](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_spirecrd.md) -- [Tornjak Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md) - - [Tornjak SPIRE Server Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#tornjak-spire-server-agent) - - [APIs](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#apis) - - [Authentication](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authentication) - - [Authorization](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authorization) +- [Tornjak Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md) + - [Tornjak SPIRE Server Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#tornjak-spire-server-agent) + - [APIs](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#apis) + - [Authentication](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authentication) + - [Authorization](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authorization) -- [Tornjak Manager](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md) - - [Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#global-visibility) - - [Identity Policy Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#identity-policy-management) - - [Auditability of Identities And Use For Operations/Forensics](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#auditability-of-identities-and-use-for-operationsforensics) - - [Management of SPIRE Identity Configurations](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#management-of-spire-identity-configurations) +- [Tornjak Manager](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md) + - [Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#global-visibility) + - [Identity Policy Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#identity-policy-management) + - [Auditability of Identities And Use For Operations/Forensics](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#auditability-of-identities-and-use-for-operationsforensics) + - [Management of SPIRE Identity Configurations](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#management-of-spire-identity-configurations) -- [Tornjak Plan](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) - - [Milestone A: Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-a-global-visibility) - - [Milestone B: Global Visibility + Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-b-global-visibility--authentication) - - [Milestone C: Policy management](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-c-policy-management) - - [Milestone D: Improve Policy definitions and UX](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-d-improve-policy-definitions-and-ux) - - [Milestone E: Auditability](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-e-auditability) - - [Milestone F: Advanced Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-f-advanced-authentication) - - [Milestone G: Enhancing SPIRE API](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-g-enhancing-spire-api) +- [Tornjak Plan](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) + - [Milestone A: Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-a-global-visibility) + - [Milestone B: Global Visibility + Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-b-global-visibility--authentication) + - [Milestone C: Policy management](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-c-policy-management) + - [Milestone D: Improve Policy definitions and UX](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-d-improve-policy-definitions-and-ux) + - [Milestone E: Auditability](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-e-auditability) + - [Milestone F: Advanced Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-f-advanced-authentication) + - [Milestone G: Enhancing SPIRE API](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-g-enhancing-spire-api) -- [Tornjak Server Configuration Reference](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md) - - [Command line options](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#command-line-options) - - [The Tornjak Config](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#the-tornjak-config) - - [General Tornjak Server Configs](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#general-tornjak-server-configs) - - [About Tornjak Plugins](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#about-tornjak-plugins) - - [Sample Configuration Files](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#sample-configuration-files) - - [Further Reading](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#further-reading) +- [Tornjak Server Configuration Reference](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md) + - [Command line options](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#command-line-options) + - [The Tornjak Config](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#the-tornjak-config) + - [General Tornjak Server Configs](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#general-tornjak-server-configs) + - [About Tornjak Plugins](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#about-tornjak-plugins) + - [Sample Configuration Files](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#sample-configuration-files) + - [Further Reading](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#further-reading) -- [Tornjak UI-API Documentation](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md) - - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#11-overview) - - [Tornjak User Interface (UI) Architecture](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture) - - [UI Pages (With their paths)](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths) - - [Tornjak User Interface (UI) Interaction with API Endpoints](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints) - - [Agent API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#31-tornjak-apis) - - [Manager API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#32-manager-apis) - - [Tornjak Redux Reducers and Actions With Their Respective Descriptions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions) - - [Reducers](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#41-reducers) - - [Actions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#42-actions) +- [Tornjak UI-API Documentation](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md) + - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#11-overview) + - [Tornjak User Interface (UI) Architecture](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture) + - [UI Pages (With their paths)](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths) + - [Tornjak User Interface (UI) Interaction with API Endpoints](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints) + - [Agent API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#31-tornjak-apis) + - [Manager API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#32-manager-apis) + - [Tornjak Redux Reducers and Actions With Their Respective Descriptions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions) + - [Reducers](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#41-reducers) + - [Actions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#42-actions) -- [User Management](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md) - - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#overview) - - [Architecture](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#architecture) - - [General Deployment](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#general-deployment) - - [Examples and Tutorials](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#examples-and-tutorials) \ No newline at end of file +- [User Management](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md) + - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#overview) + - [Architecture](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#architecture) + - [General Deployment](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#general-deployment) + - [Examples and Tutorials](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#examples-and-tutorials) From aafef6895262b690ddf415b2d75917950b108f35 Mon Sep 17 00:00:00 2001 From: Matthew <133825715+mattLif@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:23:50 -0500 Subject: [PATCH 3/5] Removed Items and Switched to Relative Linking Signed-off-by: Matthew <133825715+mattLif@users.noreply.github.com> --- docs/index.md | 87 ++++++++++++++++++++++----------------------------- 1 file changed, 37 insertions(+), 50 deletions(-) diff --git a/docs/index.md b/docs/index.md index 768a1eba..5346b0e2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,64 +1,51 @@ # Index -- [Blogs](https://github.com/spiffe/tornjak/blob/main/docs/blogs.md) +- [Blogs](/docs/blogs.md) -- [Debugging, Hints and Tips for Solving Common Problems with Tornjak](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md) - - [Tornjak Deployment](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-deployment) - - [Tornjak Configuration](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-configuration) - - [User Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#user-management) +- [Debugging, Hints and Tips for Solving Common Problems with Tornjak](/docs/tornjak-hints.md) + - [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](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) +- [JSON Format for New Entry](/docs/newEntry-json-format.md) -- [Server plugin: Authentication "Keycloak"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authentication_keycloak.md) +- [Server plugin: Authentication "Keycloak"](/docs/plugin_server_authentication_keycloak.md) -- [Server plugin: Authorization "RBAC"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authorization_rbac.md) +- [Server plugin: Authorization "RBAC"](/docs/plugin_server_authorization_rbac.md) -- [Server plugin: Datastore "SQL"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_datastore_sql.md) +- [Server plugin: Datastore "SQL"](/docs/plugin_server_datastore_sql.md) -- [Server plugin: SPIRECRDManager](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_spirecrd.md) +- [Server plugin: SPIRECRDManager](/docs/plugin_server_spirecrd.md) -- [Tornjak Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md) - - [Tornjak SPIRE Server Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#tornjak-spire-server-agent) - - [APIs](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#apis) - - [Authentication](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authentication) - - [Authorization](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authorization) +- [Tornjak Agent](/docs/tornjak-agent.md) + - [Tornjak SPIRE Server Agent](/docs/tornjak-agent.md#tornjak-spire-server-agent) + - [APIs](/docs/tornjak-agent.md#apis) + - [Authentication](/docs/tornjak-agent.md#authentication) + - [Authorization](/docs/tornjak-agent.md#authorization) -- [Tornjak Manager](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md) - - [Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#global-visibility) - - [Identity Policy Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#identity-policy-management) - - [Auditability of Identities And Use For Operations/Forensics](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#auditability-of-identities-and-use-for-operationsforensics) - - [Management of SPIRE Identity Configurations](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#management-of-spire-identity-configurations) +- [Tornjak Manager](/docs/tornjak-manager.md) -- [Tornjak Plan](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) - - [Milestone A: Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-a-global-visibility) - - [Milestone B: Global Visibility + Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-b-global-visibility--authentication) - - [Milestone C: Policy management](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-c-policy-management) - - [Milestone D: Improve Policy definitions and UX](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-d-improve-policy-definitions-and-ux) - - [Milestone E: Auditability](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-e-auditability) - - [Milestone F: Advanced Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-f-advanced-authentication) - - [Milestone G: Enhancing SPIRE API](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-g-enhancing-spire-api) +- [Tornjak Plan](/docs/newEntry-json-format.md) -- [Tornjak Server Configuration Reference](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md) - - [Command line options](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#command-line-options) - - [The Tornjak Config](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#the-tornjak-config) - - [General Tornjak Server Configs](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#general-tornjak-server-configs) - - [About Tornjak Plugins](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#about-tornjak-plugins) - - [Sample Configuration Files](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#sample-configuration-files) - - [Further Reading](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#further-reading) +- [Tornjak Server Configuration Reference](/docs/config-tornjak-server.md) + - [Command line options](/docs/config-tornjak-server.md#command-line-options) + - [The Tornjak Config](/docs/config-tornjak-server.md#the-tornjak-config) + - [General Tornjak Server Configs](/docs/config-tornjak-server.md#general-tornjak-server-configs) + - [About Tornjak Plugins](/docs/config-tornjak-server.md#about-tornjak-plugins) + - [Sample Configuration Files](/docs/config-tornjak-server.md#sample-configuration-files) + - [Further Reading](/docs/config-tornjak-server.md#further-reading) -- [Tornjak UI-API Documentation](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md) - - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#11-overview) - - [Tornjak User Interface (UI) Architecture](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture) - - [UI Pages (With their paths)](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths) - - [Tornjak User Interface (UI) Interaction with API Endpoints](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints) - - [Agent API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#31-tornjak-apis) - - [Manager API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#32-manager-apis) - - [Tornjak Redux Reducers and Actions With Their Respective Descriptions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions) - - [Reducers](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#41-reducers) - - [Actions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#42-actions) +- [Tornjak UI-API Documentation](/docs/tornjak-ui-api-documentation.md) + - [Overview](/docs/tornjak-ui-api-documentation.md#11-overview) + - [Tornjak User Interface (UI) Architecture](/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture) + - [UI Pages (With their paths)](/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths) + - [Tornjak User Interface (UI) Interaction with API Endpoints](/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints) + - [Agent API’s](/docs/tornjak-ui-api-documentation.md#31-tornjak-apis) + - [Manager API’s](/docs/tornjak-ui-api-documentation.md#32-manager-apis) + - [Tornjak Redux Reducers and Actions With Their Respective Descriptions](/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions) -- [User Management](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md) - - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#overview) - - [Architecture](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#architecture) - - [General Deployment](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#general-deployment) - - [Examples and Tutorials](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#examples-and-tutorials) +- [User Management](/docs/user-management.md) + - [Overview](/docs/user-management.md#overview) + - [Architecture](/docs/user-management.md#architecture) + - [General Deployment](/docs/user-management.md#general-deployment) + - [Examples and Tutorials](/docs/user-management.md#examples-and-tutorials) 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 4/5] 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: ``` ... From 4f91a064d2ea100db6d8d0fb3f641b1771c4cfd4 Mon Sep 17 00:00:00 2001 From: Matthew <133825715+mattLif@users.noreply.github.com> Date: Tue, 26 Nov 2024 17:13:14 -0500 Subject: [PATCH 5/5] Signed-off-by: Matthew <133825715+mattLif@users.noreply.github.com> --- docs/{index.md => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{index.md => README.md} (100%) diff --git a/docs/index.md b/docs/README.md similarity index 100% rename from docs/index.md rename to docs/README.md