Merge remote-tracking branch 'origin/main' into update-helm-reqs

docs/architecture/self-hosted/download-logs.md

@@ -2,7 +2,7 @@
 title: Download logs
 id: download-logs
 description: Download Prophecy support logs
-sidebar_position: 5
+sidebar_position: 6
 tags:
   - download
   - support logs

docs/architecture/self-hosted/generate-api-key.md

@@ -2,7 +2,7 @@
 title: Generate API key
 id: generate-api-key
 description: Generate your own custom API key per deployment
-sidebar_position: 6
+sidebar_position: 7
 tags:
   - Generate
   - API

docs/architecture/self-hosted/install-prophecy/_category_.json

@@ -0,0 +1,6 @@
+{
+  "label": "Install Prophecy",
+  "position": 1,
+  "collapsible": true,
+  "collapsed": true
+}

docs/architecture/self-hosted/install-prophecy/install-prophecy.md

@@ -0,0 +1,19 @@
+---
+title: Install Prophecy
+id: install-prophecy
+description: Learn how to install your self-hosted Prophecy environment
+sidebar_position: 1
+tags:
+  - prophecy
+  - install
+  - self-hosted
+---
+
+Explore the following pages to learn how to install your self-hosted Prophecy environment.
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+<DocCardList items={useCurrentSidebarCategory().items}/>
+```

docs/architecture/self-hosted/installation-helm/install-on-aws.mdx → docs/architecture/self-hosted/install-prophecy/installation-helm/install-on-aws.mdx

@@ -1,5 +1,5 @@
 ---
-title: Installation on AWS
+title: AWS installation guide
 id: install-on-aws
 description: Use this guide to help when installing Prophecy on AWS.
 tags:

docs/architecture/self-hosted/install-prophecy/installation-marketplaces/_category_.json

@@ -0,0 +1,6 @@
+{
+  "label": "Installation via Marketplaces",
+  "position": 2,
+  "collapsible": true,
+  "collapsed": true
+}

docs/architecture/self-hosted/install-prophecy/installation-marketplaces/install-azure-marketplace.md

@@ -0,0 +1,66 @@
+---
+title: Azure Marketplace guide
+id: install-azure-marketplace
+description: Install Prophecy via Azure Marketplace
+sidebar_position: 1
+tags:
+  - deployment
+  - installation
+  - marketplaces
+  - azure
+---
+
+This page outlines how to install Prophecy via Azure Marketplace.
+
+## Requirements
+
+To complete this process, you need:
+
+- The **Contributor** or **Owner** role in Azure.
+- A minimum of six Standard_DS4_v2 family types of VMs. You'll need to assign an appropriate quota in your Azure subscription for a region where you are planning to deploy Prophecy.
+
+:::note
+Contact Prophecy to discuss future scaling needs.
+:::
+
+## Open Azure Marketplace
+
+To get started:
+
+1. Open the [Prophecy](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/simpledatalabsinc1635791235920.prophecy-data-engineering) product page in Azure Marketplace and click **Get It Now**.
+1. In the **Create this app in Azure** window, select the **Prophecy Private SaaS - Enterprise Grade Support** plan (unless advised otherwise).
+1. Click **Continue**. You will be directed to the Azure portal.
+1. In the portal, click **Create** to begin the Prophecy IDE setup.
+
+## Create Prophecy
+
+Next, fill out the required fields of the **Basics** tab.
+
+1. Select your Azure subscription.
+1. In the **Resource group** field, choose or create a resource group for the application.
+1. Select the **Region** of the instance.
+1. For the **Configure Base Domain and TLS** option, you have two choices:
+   - Use Prophecy's Base Domain. If you choose this option, Prophecy manages the certificates and domain for you.
+   - Use your own Base Domain and Certificate. If you choose this option, you can deploy your own TLS certificates and manage the domain for the Prophecy IDE using your own DNS zones.
+1. Give the application a name.
+1. Note that this installation will generate a managed resource group where all Prophecy resources will be created.
+
+When you have finished filling out the **Basics** tab, click **Review + create**. Then, agree to the terms and conditions and click **Create**. This will start the Prophecy deployment.
+
+## Go to resource
+
+It takes around 20 to 30 minutes to finish the installation. Once installation is complete:
+
+1. Click on **Go to resource**.
+2. Click on **Parameters and Outputs**.
+3. If you are using the Prophecy domain, you will be able to access the cluster with the **prophecyURL**, **adminUser**, and **credentials**.
+4. If you are using your own domain:
+   - Note down **prophecyURL**, **loadBalancerIP**, **adminUser** and **credentials**.
+   - Reach out to your DNS admin and request to add a Type A entry for the prophecyURL and the loadBalancerIP address.
+
+## Launch the Prophecy IDE
+
+1. Open the Prophecy IDE with the prophecyURL that you noted.
+2. Login using the adminUser and credentials that you noted.
+
+Now, you are free to get started with Prophecy!

docs/architecture/self-hosted/install-prophecy/installation-marketplaces/installation-marketplaces.md

@@ -0,0 +1,23 @@
+---
+title: Installation via Marketplaces
+id: installation-marketplaces
+description: Installation via Marketplaces
+sidebar_position: 1
+tags:
+  - deployment
+  - installation
+  - marketplaces
+  - aws
+  - azure
+  - gcp
+---
+
+You can install Prophecy via various cloud marketplaces. Steps to install vary by marketplace.
+
+For an example step-by-step installation, visit the [Azure Marketplace guide](install-azure-marketplace.md).
+
+| **Marketplace**                                                                                                                     | **Installation Details**                                                                     |
+| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| [Azure](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/simpledatalabsinc1635791235920.prophecy-data-engineering)     | Prophecy is installed in a new resource group that is created as part of the installation.   |
+| [AWS](https://aws.amazon.com/marketplace/pp/prodview-gh3pyflmu7mlu?sr=0-1&ref_=beagle&applicationId=AWSMPContessa#external-reviews) | Prophecy is installed in a new EKS cluster or an existing cluster.                           |
+| [Google Cloud](https://console.cloud.google.com/marketplace/product/prophecy-on-gcp-public/prophecy-data-engineering)               | Prophecy is installed as a Kubernetes app that leverages the Google Kubernetes Engine (GKE). |

docs/architecture/self-hosted/resource-monitoring.md

@@ -0,0 +1,40 @@
+---
+title: Resource monitoring
+id: resource-monitoring
+description: Find an overview of resource monitoring, alert configuration, and scaling recommendations
+sidebar_position: 5
+tags:
+  - scaling
+  - resources
+  - monitoring
+---
+
+This page provides an overview of resource monitoring, alert configuration, and scaling recommendations for effectively managing Prophecy deployments.
+
+## Monitoring
+
+To have a better understanding of how Prophecy is using resources, you can find an overview in **Settings > Admin > Monitoring**.
+
+![Monitoring settings](./img/monitoring.png)
+
+## Alerts
+
+To set up automated alerts about your resource usage, visit the page on [Alerts Configuration](docs/architecture/self-hosted/configurations/configure-alerts.md).
+
+## Scaling
+
+Scaling is taken care of by the **Autoscaler** component in our platform. Therefore, if something happens like the number of
+users increases by 10 times, the Prophecy deployment can be scaled appropriately.
+
+The following are estimated recommended cluster sizes depending on the number of concurrent users:
+
+| Number of users           | 25       | 50       | 100       |
+| ------------------------- | -------- | -------- | --------- |
+| CPUs                      | 56 vCPUs | 96 vCPUs | 180 vCPUs |
+| Memory                    | 128 GB   | 256 GB   | 440 GB    |
+| Disk space (with backups) | 360 GB   | 720 GB   | 1440 GB   |
+
+:::info
+The recommended resource may vary based on the intensity of the usage of each developer. The numbers
+presented above are based on the average recorded usage of Prophecy customers.
+:::

docs/architecture/self-hosted/upgrade-backup-restore.md

@@ -78,6 +78,10 @@ Below is a list of supported variables that you can change.
 | `backupRetentionCount`      | Number of last `N` backups to retain.                                                                                                                                                     | `30`          |
 | `enableRegularBackups`      | State of automated backup creation.                                                                                                                                                       | `false`       |
 
+### View past backups
+
+You can view a history of backups in **Settings > Admin > Backup**.
+
 ### Additional backup APIs
 
 Here is a list of additional APIs for backups. One sample call may look like:

docusaurus.config.js

@@ -221,7 +221,7 @@ const config = {
             from: "/architecture/deployment/private-saas/generate-api-key",
           },
           {
-            to: "/architecture/self-hosted/installation-helm/",
+            to: "/architecture/self-hosted/install-prophecy/installation-helm/",
             from: "/architecture/deployment/installation-guide",
           },
           {