Skip to content

Commit

Permalink
updated readme and platform overview diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
tapas4java committed Oct 31, 2024
1 parent d242fe6 commit 538a2a5
Show file tree
Hide file tree
Showing 10 changed files with 78 additions and 365 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,15 @@ Credentials:
</details>


Once adhar finishes provisioning cluster and packages, you can access GUIs by going to the following addresses in your browser.
Once `adhar` finishes provisioning cluster and packages, you can access GUIs by going to the following addresses in your browser.

* ArgoCD: https://adhar.localtest.me:8443/argocd/ (Get the username and password from above command)
* Gitea: https://adhar.localtest.me:8443/gitea/ (Get the username and password from above command)
* Keycloak: https://adhar.localtest.me:8443/keycloak/ (Username is `adhar-admin` and password `KEYCLOAK_ADMIN_PASSWORD` retrieved from above command)
* Argo-Workflows: https://adhar.localtest.me:8443/argo-workflows/
* Adhar Console: https://adhar.localtest.me:8443/ (Username is `user1` or `user2` and password `USER-PASSWORD` retrieved from above command Keycloak section)
* ***ArgoCD***: https://adhar.localtest.me:8443/argocd/ (Get the username and password from above command)
* ***Gitea***: https://adhar.localtest.me:8443/gitea/ (Get the username and password from above command)
* ***Keycloak***: https://adhar.localtest.me:8443/keycloak/ (Username is `adhar-admin` and password `KEYCLOAK_ADMIN_PASSWORD` retrieved from above command)
* ***Argo-Workflows***: https://adhar.localtest.me:8443/argo-workflows/
* ***Adhar Console***: https://adhar.localtest.me:8443/ (Username is `user1` or `user2` and password `USER-PASSWORD` retrieved from above command Keycloak section)
* ***Headlamp***: https://adhar.localtest.me:8443/headlamp/ (Username is `user1` or `user2` and password `USER-PASSWORD` retrieved from above command Keycloak section)
* ***JupyterHub***: https://adhar.localtest.me:8443/jupyterhub/ (Username is `user1` or `user2` and password `USER-PASSWORD` retrieved from above command Keycloak section)

#### Secrets
You can obtain credentials for them by running the following command:
Expand Down Expand Up @@ -223,14 +225,14 @@ On the other hand, platform administrators can use it to enable and configure pl

Moreover, it includes a Cloud Shell feature, allowing both developers and admins to run CLI commands. In essence, the Adhar Console is a comprehensive tool designed to streamline and simplify the management of your platform.

![Adhar Console](docs/imgs/adhar-console-light.png)

![Adhar Console](docs/imgs/adhar-console-dark.png)
![Adhar Console](docs/imgs/adhar-console.png)

### Command Line Interface (CLI)

The Adhar Command Line Interface (CLI) provides a powerful tool for developers and administrators to interact with the Adhar platform, enabling them to manage resources, execute tasks, and automate workflows directly from the command line.

![Adhar Console](docs/imgs/adhar-cli.png)

### Platform Control plane (api-server)

In the Adhar platform, the api-server plays a crucial role in enabling seamless integration. Every alteration made via the Console is first verified by the api-server within the control plane. Once validated, these changes are stored in the state store. This action initiates an automatic process where the platform aligns the actual state with the desired state, thereby ensuring smooth integration and consistency across the platform.
Expand All @@ -245,7 +247,7 @@ Upon installation of Adhar, the desired state of the platform is captured and pr

### Golden Templates Catalog

The `adhar/helm-charts` Git repository houses a collection of built-in Helm charts, which serve as the backbone for creating workloads within the Console. These charts are designed as golden templates, adhering to trending technology standards, ensuring optimal performance and compatibility. In addition to the built-in charts, the platform also offers the flexibility to add custom charts. This allows users to tailor their workloads to specific needs while maintaining the benefits of standardization. Thus, the `adhar/helm-charts` repository is not just a resource, but a gateway to efficient and standardized workload management on the Adhar platform.
The `adhar-io/adhar-templates` Git repository houses a collection of built-in Helm charts, which serve as the backbone for creating workloads within the Console. These charts are designed as golden templates, adhering to trending technology standards, ensuring optimal performance and compatibility. In addition to the built-in charts, the platform also offers the flexibility to add custom charts. This allows users to tailor their workloads to specific needs while maintaining the benefits of standardization. Thus, the `adhar-io/adhar-templates` repository is not just a resource, but a gateway to efficient and standardized workload management on the Adhar platform.

### Automation & Self Service

Expand Down
Binary file added docs/imgs/adhar-cli.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/imgs/adhar-console-dark.png
Binary file not shown.
Binary file removed docs/imgs/adhar-console-light.png
Binary file not shown.
Binary file added docs/imgs/adhar-console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
124 changes: 65 additions & 59 deletions docs/imgs/adhar-platform.drawio

Large diffs are not rendered by default.

Binary file modified docs/imgs/adhar-platform.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/imgs/adhar-platform.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/imgs/adhar-platform.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 538a2a5

Please sign in to comment.