Skip to content

Commit

Permalink
azure marketplace installation
Browse files Browse the repository at this point in the history
  • Loading branch information
kathweinschenkprophecy committed Dec 13, 2024
1 parent 72fe67c commit e42c8c3
Show file tree
Hide file tree
Showing 11 changed files with 120 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"label": "Install Prophecy",
"position": 1,
"collapsible": true,
"collapsed": true
}
19 changes: 19 additions & 0 deletions docs/architecture/self-hosted/install-prophecy/install-prophecy.md
Original file line number Diff line number Diff line change
@@ -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}/>
```
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"label": "Installation via Marketplaces",
"position": 2,
"collapsible": true,
"collapsed": true
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
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.

![Prophecy on Azure Marketplace](./img/azure-marketplace.png)

## Requirements

To complete this process, you need:

- The `Contributor` or `Owner` role in Azure. A new resource group will be created as part of the installation and all the Prophecy resources will be created inside it.
- A minimum of 6 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.
2. Click **Get It Now**.
3. In the **Create this app** in Azure window, click **Continue**. You will be directed to the Azure portal.
4. In the portal, click **Create** to begin the Prophecy IDE setup.

## Create Prophecy

Next, fill out the required fields of the **Basics** tab.

For the **Configure Base Domain and TLS** option, note these 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.

When you have finished filling out the **Basics** tab, click **Review + create**. Then, agree to the terms and conditions and click **Create**.

## 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!
Original file line number Diff line number Diff line change
@@ -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). |
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,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",
},
],
Expand Down

0 comments on commit e42c8c3

Please sign in to comment.