From c60e0e32e6940f2f69ececc538ec79b1aa16b62a Mon Sep 17 00:00:00 2001 From: Johannes Kastl Date: Thu, 26 Oct 2023 17:19:23 +0200 Subject: [PATCH 1/4] README.md: typo soltuions, whitespace removed --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a7fa210..f1e0e58 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This command will deploy a stand-alone OpenUnison instance. It can deploy as bo -t, --smtp-secret-path string Path to file containing the smtp password` ``` -If run on an existing cluster, this command will upgrade existing charts. For authentication soltuions that require a secret, this command can be re-run without that secret safely. +If run on an existing cluster, this command will upgrade existing charts. For authentication solutions that require a secret, this command can be re-run without that secret safely. ## install-satelite From 4cd4b4d095f32055ceca4a0ef2a58f3af530fb40 Mon Sep 17 00:00:00 2001 From: Johannes Kastl Date: Fri, 27 Oct 2023 06:57:50 +0200 Subject: [PATCH 2/4] README.md: replace double spaces with single spaces --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f1e0e58..185fc2e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # ouctl -This utility automates the deployment of OpenUnison's helm charts into your cluster. It has helm built in, so it doesn't need to use an external helm binary. It has two commands, one for deploying a stand-alone OpenUnison instance and one for deploying a satelite instance. Prior to using this tool, refer to the [OpenUnison deployment guide](https://openunison.github.io/deployauth/) for instructions on how to configure OpenUnison's values.yaml. +This utility automates the deployment of OpenUnison's helm charts into your cluster. It has helm built in, so it doesn't need to use an external helm binary. It has two commands, one for deploying a stand-alone OpenUnison instance and one for deploying a satelite instance. Prior to using this tool, refer to the [OpenUnison deployment guide](https://openunison.github.io/deployauth/) for instructions on how to configure OpenUnison's values.yaml. ## install-auth-portal -This command will deploy a stand-alone OpenUnison instance. It can deploy as both an [authentication portal](https://openunison.github.io/) and as a [Namespace as a Service (NaaS) portal](https://openunison.github.io/namespace_as_a_service/). Prior to running this command, a values.yaml file will need to be created. It is the only required argument for this command. Optional flags: +This command will deploy a stand-alone OpenUnison instance. It can deploy as both an [authentication portal](https://openunison.github.io/) and as a [Namespace as a Service (NaaS) portal](https://openunison.github.io/namespace_as_a_service/). Prior to running this command, a values.yaml file will need to be created. It is the only required argument for this command. Optional flags: ``` -m, --cluster-management-chart string Helm chart for enabling cluster management (default "tremolo/openunison-k8s-cluster-management") @@ -19,17 +19,17 @@ This command will deploy a stand-alone OpenUnison instance. It can deploy as bo -t, --smtp-secret-path string Path to file containing the smtp password` ``` -If run on an existing cluster, this command will upgrade existing charts. For authentication solutions that require a secret, this command can be re-run without that secret safely. +If run on an existing cluster, this command will upgrade existing charts. For authentication solutions that require a secret, this command can be re-run without that secret safely. ## install-satelite -To support [Multi cluster SSO](https://openunison.github.io/multi_cluster_sso/) This command installs a satelite instance of OpenUnison onto a remote instance. It has three arguments: +To support [Multi cluster SSO](https://openunison.github.io/multi_cluster_sso/) This command installs a satelite instance of OpenUnison onto a remote instance. It has three arguments: 1. The path to the new OpenUnison's values.yaml 2. The name of the context in your kubectl configuration file for the control plane Kubernetes cluster 3. The name of the context in your kubectl configuration file for the new satelite cluster -This command will make several changes to your values.yaml to automate the installation, such as configuring the `oidc` section for you. There's no need to create a secret for this mode, the command will create it for you. +This command will make several changes to your values.yaml to automate the installation, such as configuring the `oidc` section for you. There's no need to create a secret for this mode, the command will create it for you. Optional flags: @@ -44,4 +44,4 @@ Optional flags: -s, --save-satelite-values-path string If specified, the values generated for the satelite integration on the control plane are saved to this path ``` -This command can be re-run safely. If charts have already been deployed, they'll be updated. +This command can be re-run safely. If charts have already been deployed, they'll be updated. From 215c61628f87edbaf7a42b61747c40561705cedf Mon Sep 17 00:00:00 2001 From: Johannes Kastl Date: Fri, 27 Oct 2023 07:05:53 +0200 Subject: [PATCH 3/4] README.md: formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 185fc2e..39e0792 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ouctl -This utility automates the deployment of OpenUnison's helm charts into your cluster. It has helm built in, so it doesn't need to use an external helm binary. It has two commands, one for deploying a stand-alone OpenUnison instance and one for deploying a satelite instance. Prior to using this tool, refer to the [OpenUnison deployment guide](https://openunison.github.io/deployauth/) for instructions on how to configure OpenUnison's values.yaml. +This utility automates the deployment of OpenUnison's helm charts into your cluster. It has helm built in, so it doesn't need to use an external helm binary. It has two commands, one for deploying a stand-alone OpenUnison instance and one for deploying a satelite instance. Prior to using this tool, refer to the [OpenUnison deployment guide](https://openunison.github.io/deployauth/) for instructions on how to configure OpenUnison's `values.yaml`. ## install-auth-portal From 1e91ccb17182ed22cede354f23563336cb85a54f Mon Sep 17 00:00:00 2001 From: Johannes Kastl Date: Fri, 27 Oct 2023 07:07:58 +0200 Subject: [PATCH 4/4] README.md: small changes --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 39e0792..5db50b2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ This utility automates the deployment of OpenUnison's helm charts into your clus ## install-auth-portal -This command will deploy a stand-alone OpenUnison instance. It can deploy as both an [authentication portal](https://openunison.github.io/) and as a [Namespace as a Service (NaaS) portal](https://openunison.github.io/namespace_as_a_service/). Prior to running this command, a values.yaml file will need to be created. It is the only required argument for this command. Optional flags: +The `ouctl install-auth-portal` command will deploy a stand-alone OpenUnison instance. It can deploy as both an [authentication portal](https://openunison.github.io/) and as a [Namespace as a Service (NaaS) portal](https://openunison.github.io/namespace_as_a_service/). Prior to running this command, a `values.yaml` file will need to be created. It is the only required argument for this command. + +Optional flags are: ``` -m, --cluster-management-chart string Helm chart for enabling cluster management (default "tremolo/openunison-k8s-cluster-management") @@ -19,7 +21,7 @@ This command will deploy a stand-alone OpenUnison instance. It can deploy as bot -t, --smtp-secret-path string Path to file containing the smtp password` ``` -If run on an existing cluster, this command will upgrade existing charts. For authentication solutions that require a secret, this command can be re-run without that secret safely. +If run this command on a cluster with an existing OpenUnison instance, it will upgrade the existing charts. For authentication solutions that require a secret, this command can be re-run without that secret safely. ## install-satelite