Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENDOC-597 k8s guidance #601

Merged
merged 3 commits into from
Oct 24, 2022
Merged

ENDOC-597 k8s guidance #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc7a0fd
ENDOC-596 Update getting started command to be specific to the curren…
nshaw Oct 24, 2022
3f09069
ENDOC-597 Refine k8s minimum footprint requirements
nshaw Oct 24, 2022
97b31c7
ENDOC-597 Refine k8s minimum footprint requirements
nshaw Oct 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions vuepress/docs/next/docs/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@ The following steps launch an Ubuntu VM via Multipass, install Kubernetes, then

2. Install Entando into Kubernetes on Ubuntu using the [Entando CLI](entando-cli.md)

```sh
curl -sfL https://get.entando.org | bash
```
<EntandoCode> curl -sL "https://get.entando.org" | ENTANDO_RELEASE="{{ $site.themeConfig.entando.fixpack.v71 }}" bash
</EntandoCode>

3. The progress of the install is displayed on the console. Installation can take up to 10 minutes, depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To understand what the CLI does, review the manual steps.
4. The URL to access the Entando App Builder will print to the console once the install completes.
Expand Down
13 changes: 6 additions & 7 deletions vuepress/docs/next/tutorials/getting-started/kubernetes-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ Below are the minimum infrastructure requirements to install Entando directly on
- To install bundles, the cluster containing the Entando Application must have access to the bundle repository (either public or private, often on GitHub) as well as the Docker image repository (e.g. DockerHub) for any microservices.
- Kubernetes Secrets are required to [install bundles from a private image repository](../curate/private-images.md), such as DockerHub.

The baseline resource requirements for Entando are specified below. Actual requirements depend on utilization and increase with features, bundles and capabilities. In addition, Kubernetes has its own resource requirements, which vary depending on the distribution. At a minimum, configure a single worker node with the resources listed below. Alternatively, begin with 3 worker nodes, each with at least 2 vCPUs and 4 GB of RAM.

## Minimum Hardware Requirements

Minimum hardware requirements depend on how Entando is used. As a general rule, an increase in functionality necessitates additional capabilities and resources.
### Entando Install Only
### Entando Application Only

- 6 vCPUs (6000 millicores)
- 6 GB of RAM
- 4 vCPUs (4000 millicores)
- 8 GB of RAM
- 5 GB of allocated storage distributed over many PVCs

Configure a single worker node with the requirements above or designate 3 worker nodes, each with a minimum of 2 PVCs and 4 GB of RAM.

### Entando + Microservices

- 500 millicores per microservice, or
Expand All @@ -32,7 +31,7 @@ The microservices tested with the CPU specs above were generated using the JHips

Complexity, content and number of pages determine the hardware requirements of an Entando install that includes the CMS. The minimum requirements are:

- 9 vCPUs for a single CMS instance. To scale up, allocate 4 vCPUs per replica.
- 6 vCPUs for a single CMS instance. To scale up, allocate 4 vCPUs per replica.
- 8 GB of RAM for a single CMS instance. To scale up, allocate 4 GB of RAM per replica.
- A minimum of 50 GB of storage for the static resources generated by the use of the Entando CMS.

Expand Down
8 changes: 4 additions & 4 deletions vuepress/docs/v7.1/docs/curate/bundle-component-details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,8 +435,8 @@ It should return an 8 digit string of numbers and letters, e.g. bundle-id=8785d9
#### Samples
Here are example tags to access static resources in a typical bundle:
```
<img src="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/images/logo.png">
<link rel="stylesheet" href="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/resources/css/styles.css">
<link rel="shortcut icon" href="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/images/favicon.ico" type="image/x-icon"/>
<script type="application/javascript" src="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/js/script.js"></script>
<img src="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/images/logo.png">
<link rel="stylesheet" href="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/resources/css/styles.css">
<link rel="shortcut icon" href="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/images/favicon.ico" type="image/x-icon"/>
<script type="application/javascript" src="<@wp.resourceURL />bundles/YOUR-BUNDLE-CODE/js/script.js"></script>
```
5 changes: 2 additions & 3 deletions vuepress/docs/v7.1/docs/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@ The following steps launch an Ubuntu VM via Multipass, install Kubernetes, then

2. Install Entando into Kubernetes on Ubuntu using the [Entando CLI](entando-cli.md)

```sh
curl -sfL https://get.entando.org | bash
```
<EntandoCode> curl -sL "https://get.entando.org" | ENTANDO_RELEASE="{{ $site.themeConfig.entando.fixpack.v71 }}" bash
</EntandoCode>

3. The progress of the install is displayed on the console. Installation can take up to 10 minutes, depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To understand what the CLI does, review the manual steps.
4. The URL to access the Entando App Builder will print to the console once the install completes.
Expand Down
13 changes: 6 additions & 7 deletions vuepress/docs/v7.1/tutorials/getting-started/kubernetes-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ Below are the minimum infrastructure requirements to install Entando directly on
- To install bundles, the cluster containing the Entando Application must have access to the bundle repository (either public or private, often on GitHub) as well as the Docker image repository (e.g. DockerHub) for any microservices.
- Kubernetes Secrets are required to [install bundles from a private image repository](../curate/private-images.md), such as DockerHub.

The baseline resource requirements for Entando are specified below. Actual requirements depend on utilization and increase with features, bundles and capabilities. In addition, Kubernetes has its own resource requirements, which vary depending on the distribution. At a minimum, configure a single worker node with the resources listed below. Alternatively, begin with 3 worker nodes, each with at least 2 vCPUs and 4 GB of RAM.

## Minimum Hardware Requirements

Minimum hardware requirements depend on how Entando is used. As a general rule, an increase in functionality necessitates additional capabilities and resources.
### Entando Install Only
### Entando Application Only

- 6 vCPUs (6000 millicores)
- 6 GB of RAM
- 4 vCPUs (4000 millicores)
- 8 GB of RAM
- 5 GB of allocated storage distributed over many PVCs

Configure a single worker node with the requirements above or designate 3 worker nodes, each with a minimum of 2 PVCs and 4 GB of RAM.

### Entando + Microservices

- 500 millicores per microservice, or
Expand All @@ -32,7 +31,7 @@ The microservices tested with the CPU specs above were generated using the JHips

Complexity, content and number of pages determine the hardware requirements of an Entando install that includes the CMS. The minimum requirements are:

- 9 vCPUs for a single CMS instance. To scale up, allocate 4 vCPUs per replica.
- 6 vCPUs for a single CMS instance. To scale up, allocate 4 vCPUs per replica.
- 8 GB of RAM for a single CMS instance. To scale up, allocate 4 GB of RAM per replica.
- A minimum of 50 GB of storage for the static resources generated by the use of the Entando CMS.

Expand Down