fix(docs): add documentation for Gluu Solo (#1962)

* docs: create solo Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: add gluu solo detail Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: create domain page Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: create subscription page Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: update subscription doc Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: update subscription Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): update solo doc Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: update domain doc Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): updates to Solo overview Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): restructure Solo docs Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): rename overview Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): change heading Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): update solo mermaid Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): add subscription process screens Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): add subscription process screens Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): update subscription process Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): review and add content Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): rename file and fix links Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): update title Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): fix the file name Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): solo confuguration changes Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): Add the information in the docs Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * fix(docs): fix format issue Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> --------- Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
GluuFederation · Jan 29, 2025 · 1ba639f · 1ba639f
1 parent ff255fd
commit 1ba639f
Show file tree

Hide file tree

Showing 22 changed files with 241 additions and 1 deletion.
diff --git a/docs/assets/agama-lab/solo-account-details.png b/docs/assets/agama-lab/solo-account-details.png
diff --git a/docs/assets/agama-lab/solo-agama-lab-main-page.png b/docs/assets/agama-lab/solo-agama-lab-main-page.png
diff --git a/docs/assets/agama-lab/solo-billing-details.png b/docs/assets/agama-lab/solo-billing-details.png
diff --git a/docs/assets/agama-lab/solo-billing-page.png b/docs/assets/agama-lab/solo-billing-page.png
diff --git a/docs/assets/agama-lab/solo-checkout-bill-plan.png b/docs/assets/agama-lab/solo-checkout-bill-plan.png
diff --git a/docs/assets/agama-lab/solo-checkout-confirmation.png b/docs/assets/agama-lab/solo-checkout-confirmation.png
diff --git a/docs/assets/agama-lab/solo-configuration.png b/docs/assets/agama-lab/solo-configuration.png
diff --git a/docs/assets/agama-lab/solo-creating-new-instance.png b/docs/assets/agama-lab/solo-creating-new-instance.png
diff --git a/docs/assets/agama-lab/solo-custom-domain.png b/docs/assets/agama-lab/solo-custom-domain.png
diff --git a/docs/assets/agama-lab/solo-instance-preview.png b/docs/assets/agama-lab/solo-instance-preview.png
diff --git a/docs/assets/agama-lab/solo-order-completion.png b/docs/assets/agama-lab/solo-order-completion.png
diff --git a/docs/assets/agama-lab/solo-payment-details.png b/docs/assets/agama-lab/solo-payment-details.png
diff --git a/docs/assets/agama-lab/solo-payment-success-confirmation.png b/docs/assets/agama-lab/solo-payment-success-confirmation.png
diff --git a/docs/assets/agama-lab/solo-price-confirmation.png b/docs/assets/agama-lab/solo-price-confirmation.png
diff --git a/docs/assets/agama-lab/solo-settings-page.png b/docs/assets/agama-lab/solo-settings-page.png
diff --git a/docs/assets/agama-lab/solo-subscription-form-default-domain.png b/docs/assets/agama-lab/solo-subscription-form-default-domain.png
diff --git a/docs/assets/agama-lab/solo-subscription-plans.png b/docs/assets/agama-lab/solo-subscription-plans.png
diff --git a/docs/solo/cloud-setup.md b/docs/solo/cloud-setup.md
diff --git a/docs/solo/solo-administration-guide.md b/docs/solo/solo-administration-guide.md
@@ -0,0 +1,67 @@
+---
+tags:
+ - solo
+ - gluu
+ - administration
+ - space
+---
+
+
+
+
+!!! info
+     **Gluu Solo will be released soon. Stay tuned.**
+
+
+# Gluu Solo Administration
+
+
+Gluu Solo administration allows you to configure and control various
+aspects of the cloud infrastructure and the IDP. 
+
+From the Solo space dashboard click on
+ `Configuration` button to open the configurations page. This page lists 
+ different ways to manage the configuration.
+
+![](../assets/agama-lab/solo-configuration.png)
+
+IaC(Infrastructure As Code) using Terraform is the `recommended` method to 
+configure Gluu Solo cloud infrastructure and administer the IDP. 
+Gluu Solo provides processes and guidelines about how to manage the
+infrastructure. It also provides the actual code that
+represents the current infrastructure. Use this code and the prescribed 
+process to configure the cloud infrastructure to your needs.
+
+## Alternative methods for Ad-hoc administration
+
+```
+These tools should not be used as the go to tool for IDP configurations. Please use Terraform for managing your development and production environments.
+```
+
+Gluu Solo offers two tools to configure the IDP to your needs.
+
+### Admin UI
+
+Admin UI is a web-based administration portal for Gluu Solo IDP. Refer to 
+[Admin UI documentation](https://docs.gluu.org/head/admin/admin-ui/left-nav-menu/) 
+for more details.
+
+### Text-Based UI
+
+You can use [text-based UI](https://docs.jans.io/head/janssen-server/config-guide/config-tools/jans-tui/) to administer the Gluu Solo IDP using terminal/shell access. Install 
+TUI on your workstation using [these instructions](https://docs.jans.io/head/janssen-server/config-guide/config-tools/jans-tui/#standalone-installation) and then use 
+the terminal to connect and administer the IDP remotely.
+
+## Configuring CIDR and Integrations
+
+Administrators can manage and update the CIDR and integration settings from 
+`Settings` Page.
+
+![](../assets/agama-lab/solo-settings-page.png)
+
+## Gluu Solo Billing
+
+Solo spaces billing page provides details of the current billing plan, usage and
+the payment history.
+
+![](../assets/agama-lab/solo-billing-page.png)
diff --git a/docs/solo/solo-getting-started.md b/docs/solo/solo-getting-started.md
@@ -0,0 +1,53 @@
+---
+tags:
+  - solo
+  - Gluu
+---
+
+
+!!! info
+     **Gluu Solo will be released soon. Stay tuned.**
+
+
+# Getting Started with Gluu Solo
+
+Gluu Solo is a cloud-based identity management service designed to provide secure, scalable, 
+and dedicated authentication solutions for businesses. It eliminates the need for complex 
+infrastructure management by offering a Software-as-a-Service (SaaS) model tailored to various 
+business requirements.
+
+Curious about features! Check out [Gluu Solo] website for more. 
+
+To start using Gluu Solo, sign into Agama Lab. In a few steps, you'll be able to go-live with Gluu Solo:
+
+```mermaid
+flowchart TD
+    A(Agama Lab Login) --> B(Subscribe to Solo)  
+    B --> C(Setup the cloud instance)
+    C --> D(Go Live!)   
+
+    click A href "#agama-lab-sign-in"
+    click B href "#subscription"
+    click C href "#setting-up-gluu-solo-environment"
+    click D href "#go-live"
+```
+
+## Agama Lab Sign in
+
+[Sign-in to the Agama Lab](https://gluu.org/agama-lab/) using an existing account or create a new account.
+
+## Subscription
+
+Gluu Solo offers various subscription plans tailored to different business needs. 
+Each plan allows you to choose from multiple cloud locations and offers an SLA that 
+aligns with your identity management requirements.
+Check out [subscription process](./solo-subscription.md) to know more. 
+
+
+## Setting up Gluu Solo cloud environment and IDP
+
+Once your subscription is active, cloud instance provisioning starts. Administrator can set up the [domain](./solo-administration-guide.md#using-a-custom-domain), [configure](./solo-administration-guide.md#terraform-configuration) Gluu Solo, [integrate monitoring tools](./solo-administration-guide.md#monitoring-and-logging).
+
+## Go Live
+
+After setting up the cloud environment, Gluu Solo is ready to go live.
diff --git a/docs/solo/solo-subscription.md b/docs/solo/solo-subscription.md
@@ -0,0 +1,114 @@
+---
+tags:
+  - solo
+  - Gluu
+  - Subscription
+---
+
+
+!!! info
+     **Gluu Solo will be released soon. Stay tuned.**
+
+
+# Gluu Solo Subscription
+
+Customers require active Gluu Solo subscription in order to avail Gluu Solo 
+services. Customers can opt one of the Gluu Solo subscription plans according
+to the business need. 
+
+New customers can subscribe to Gluu Solo using the 
+[Agama Lab](https://gluu.org/agama-lab/).
+
+## Subscription process
+
+1. Sign-in to the [Agama Lab](https://gluu.org/agama-lab/). Navigate to `Solo`.
+2. To begin the subscription process, click the `Subscribe` button.
+
+    ![](../assets/agama-lab/solo-agama-lab-main-page.png)
+
+3. Choose a subscription plan
+
+     You will see a list of available plans. Select the plan that best suits 
+     your business needs and click `Continue`. 
+
+     ![](../assets/agama-lab/solo-subscription-plans.png)
+
+4. Review cost
+
+     * After clicking `Continue`, a pop-up will appear showing the `cost per request per locations` of the selected plan.
+     * Click on `Continue` to proceed to the next step
+
+     ![](../assets/agama-lab/solo-price-confirmation.png)
+
+5. Fill the subscription form
+     * Fill out the subscription form shown in the image below.
+     * FQDN: You can either use the domain assigned by Gluu(default choice), or
+     specify a custom domain that you own in the FQDN input. 
+     ![](../assets/agama-lab/solo-subscription-form-default-domain.png)
+     If you use a custom domain, you'll need to update the DNS records for the 
+     same. A note related to custom domains will appear (as shown in the image below).
+     ![](../assets/agama-lab/solo-custom-domain.png)
+
+6. Checkout
+
+     * After entering the required information, you will be directed to the checkout page.
+     * This page will display details about the selected plan, Gluu components, and a preview of
+     your instance configuration.
+     * You will also need to choose your billing plan: `Per Month` or `Per Year`.
+
+     ![](../assets/agama-lab/solo-checkout-bill-plan.png)
+
+     ![](../assets/agama-lab/solo-instance-preview.png)
+
+     * After reviewing this information, click on `Proceed To Payment`.
+
+7. Initiate payment
+
+    * A pop-up will display the total amount of your order for confirmation.
+    * Click `Proceed to Checkout` to continue.
+
+    ![](../assets/agama-lab/solo-checkout-confirmation.png)
+
+8. Add account details
+
+    * You will be prompted to enter your account details.
+    * After entering your details, click `Next` to continue.
+
+    ![](../assets/agama-lab/solo-account-details.png)
+
+9. Add billing address
+
+    * You will then need to add your billing address.
+    * After filling in your address, click `Next` to continue.
+
+    ![](../assets/agama-lab/solo-billing-details.png)
+
+10. Add payment details
+
+    * Next, you will need to add your payment details.
+    * Once the details are entered, click `Next` to proceed.
+
+    ![](../assets/agama-lab/solo-payment-details.png)
+
+11. Verify and confirm payment
+
+    * A pop-up will appear showing all the details you've entered.
+    * Verify the information and, if everything is correct, proceed to Pay to subscribe to the plan.
+
+     ![](../assets/agama-lab/solo-order-completion.png)
+
+12. Subscription confirmation
+
+    * Upon successful payment, you will be directed to a `Thank You` page. 
+    Click on `Go To Solo Space` to access your instance dashboard.
+
+    ![](../assets/agama-lab/solo-payment-success-confirmation.png)
+
+13. Access Solo space
+
+    * Solo space shows your current instance and runtime status.
+
+    ![](../assets/agama-lab/solo-creating-new-instance.png)
+
+
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -173,4 +173,10 @@ nav:
       - Configuration Instructions: openbanking/configuration-instructions.md
       - Managing scripts with CURL: openbanking/curl.md
       - Managing Scripts with the jans-cli: openbanking/jans-cli.md
-  - PAR and JARM: openbanking/par-jarm.md
+  - PAR and JARM: openbanking/par-jarm.md
+
+- 'Gluu Solo':
+  - 'solo/solo-getting-started.md'
+  - How To Subscribe: solo/solo-subscription.md
+  - Administration Guide: solo/solo-administration-guide.md
+