Skip to content

Commit

Permalink
update per review
Browse files Browse the repository at this point in the history
  • Loading branch information
kathweinschenkprophecy committed Dec 20, 2024
1 parent 7cb75d9 commit 1fe3c7b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,8 @@ tags:
- aws
---

import TOCInline from "@theme/TOCInline";

If you are deploying Prophecy with the private SaaS option, you need to install Prophecy in your Virtual Private Cloud (VPC). Use this guide to help when installing Prophecy on AWS.

<TOCInline toc={toc} maxHeadingLevel={2} />

## Get started

In this guide, we'll walk you through how to install Prophecy on an [EKS cluster](https://aws.amazon.com/eks/) in AWS. Note that this is just one recommended way to perform the installation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ For an example step-by-step installation, visit [Installation on AWS](install-on
### Helm requirements

- **[Helm](https://helm.sh/docs/intro/quickstart/)**: Must be installed to deploy Prophecy.
- **Custom Domain Hosting**: Requires SSL certificates and DNS configuration; include during Helm installation.
- **Private Container Registry**: Download images from `gcr.io/prophecy-share` and set `global.repository` during Helm installation.
- **[Custom Domain Hosting](#custom-domain-names)**: Requires SSL certificates and DNS configuration; include during Helm installation.
- **[Private Container Registry](#private-container-registry)**: Pull images from `gcr.io/prophecy-share` and push to your private registry. Set `global.repository` during Helm installation.

### Minimum service requirements
### Minimum resource requirements

| Components | Description | # Cores | # RAM | # Block Storage |
| ---------------------- | --------------------------------------------------------------------------- | -------- | ----- | --------------- |
| Prophecy core services | Main services (front-end, code editor, metadata, lineage, etc.) | 40 Cores | 78GB | 160GB |
| Platform | Backup (twice a day, configurable), monitoring, logging services (optional) | 4 Cores | 8GB | 200GB |
| Components | Description | # Cores | # RAM | # Block Storage |
| ---------------------- | --------------------------------------------------------------- | -------- | ----- | --------------- |
| Prophecy core services | Main services (front-end, code editor, metadata, lineage, etc.) | 40 Cores | 78GB | 160GB |
| Platform | Backups, monitoring, logging services (optional) | 4 Cores | 8GB | 200GB |

## Install Prophecy

Expand Down Expand Up @@ -79,9 +79,9 @@ Here are some configurations that are commonly changed from the default.

By default, Prophecy will install its own managed Nginx ingress controller during the Helm installation. If you want to use your own Nginx ingress controller already installed on your Kubernetes cluster, you can do so if it supports external service exposure via a LoadBalancer. You'll have to set `global.disableIngressCreation` to true, and set `global.ingressController.class` to the appropriate name.

#### Internal repository
#### Private container registry

During the Helm installation, docker images are pulled from Prophecy's public Google Container Registry `gcr.io/prophecy-share`. If you want to use your own internal container registry, you can specify it by setting the `global.repository` value during installation. Make sure to download the images from the public GCR first.
During the Helm installation, docker images are pulled from Prophecy's public Google Container Registry `gcr.io/prophecy-share`. If you want to use your own internal container registry, you can specify it by setting the `global.repository` value during installation. Make sure to push all the images to your private registry first.

#### Custom domain names

Expand Down

0 comments on commit 1fe3c7b

Please sign in to comment.