Skip to content

Commit a88a562

Browse files
authored
Merge pull request #28429 from abrennan89/glossary01
[SRVCOM-967] Updating terms and clean up serverless docs sections
2 parents 046be1c + 9a4f959 commit a88a562

File tree

2 files changed

+36
-31
lines changed

2 files changed

+36
-31
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// serverless/installing_serverless/installing-openshift-serverless.adoc
4+
5+
[id="serverless-cluster-sizing-req_{context}"]
6+
= Defining cluster size requirements for an {ServerlessProductName} installation
7+
8+
To install and use {ServerlessProductName}, the {product-title} cluster must be sized correctly.
9+
The minimum requirement for {ServerlessProductName} is a cluster with 10 CPUs and 40GB memory.
10+
The total size requirements to run {ServerlessProductName} are dependent on the applications deployed. By default, each pod requests approximately 400m of CPU, so the minimum requirements are based on this value.
11+
In the size requirement provided, an application can scale up to 10 replicas. Lowering the actual CPU request of applications can increase the number of possible replicas.
12+
13+
[NOTE]
14+
====
15+
The requirements provided relate only to the pool of worker machines of the {product-title} cluster. Master nodes are not used for general scheduling and are omitted from the requirements.
16+
====
17+
18+
[NOTE]
19+
====
20+
The following limitations apply to all {ServerlessProductName} deployments:
21+
22+
* Maximum number of Knative services: 1000
23+
* Maximum number of Knative revisions: 1000
24+
====

serverless/installing_serverless/installing-openshift-serverless.adoc

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -13,46 +13,27 @@ This guide walks cluster administrators through installing the {ServerlessOperat
1313
{ServerlessProductName} is supported for installation in a restricted network environment. For more information, see xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
1414
====
1515

16-
[id="installing-openshift-serverless-cluster-sizing"]
17-
== Cluster sizing requirements
18-
19-
To run {ServerlessProductName}, the {product-title} cluster must be sized correctly.
20-
The minimum requirement to use {ServerlessProductName} is a cluster with 10 CPUs and 40GB memory.
21-
22-
The total size requirements to run {ServerlessProductName} are dependent on the applications deployed. By default, each pod requests ~400m of CPU, so the minimum requirements are based on this value.
23-
24-
In the size requirement provided, an application can scale up to 10 replicas. Lowering the actual CPU request of applications can increase the number of possible replicas.
25-
26-
You can use the MachineSet API to manually scale your cluster up to the desired size. The minimum requirements usually mean that you must scale up one of the default MachineSets by two additional machines.
27-
28-
For more information on using the MachineSet API, see the documentation on xref:../../machine_management/creating_machinesets/creating-machineset-aws.adoc#creating-machineset-aws[Creating MachineSets].
29-
30-
For more information on scaling a MachineSet manually, see the documentation on xref:../../machine_management/manually-scaling-machineset.adoc#manually-scaling-machineset[manually scaling MachineSets].
31-
32-
[NOTE]
33-
====
34-
The requirements provided relate only to the pool of worker machines of the {product-title} cluster. Master nodes are not used for general scheduling and are omitted from the requirements.
16+
[IMPORTANT]
3517
====
36-
37-
[NOTE]
18+
Before upgrading to the latest Serverless release, you must remove the community Knative Eventing Operator if you have previously installed it. Having the Knative Eventing Operator installed will prevent you from being able to install the latest version of Knative Eventing using the {ServerlessOperatorName}.
3819
====
39-
The following limitations apply to all {ServerlessProductName} deployments:
4020

41-
* Maximum number of Knative services: 1000
42-
* Maximum number of Knative revisions: 1000
43-
====
21+
include::modules/serverless-cluster-sizing-req.adoc[leveloffset=+1]
4422

45-
=== Additional requirements for advanced use-cases
23+
[id="installing-openshift-serverless-advanced-reqs"]
24+
== Additional requirements for advanced use cases
4625

47-
For more advanced use-cases such as logging or metering on {product-title}, you must deploy more resources. Recommended requirements for such use-cases are 24 CPUs and 96GB of memory.
26+
For more advanced use cases such as logging or metering on {product-title}, you must deploy more resources. Recommended requirements for such use cases are 24 CPUs and 96GB of memory.
4827

4928
If you have high availability (HA) enabled on your cluster, this requires between 0.5 - 1.5 cores and between 200MB - 2GB of memory for each replica of the Knative Serving control plane.
5029
HA is enabled for some Knative Serving components by default. You can disable HA by following the documentation on xref:../../serverless/serverless-HA.adoc#serverless-HA[Configuring high availability replicas on {ServerlessProductName}].
5130

52-
[IMPORTANT]
53-
====
54-
Before upgrading to the latest Serverless release, you must remove the community Knative Eventing Operator if you have previously installed it. Having the Knative Eventing Operator installed will prevent you from being able to install the latest version of Knative Eventing using the {ServerlessOperatorName}.
55-
====
31+
[id="installing-openshift-serverless-scaling-with-machinesets"]
32+
== Scaling your cluster using machine sets
33+
34+
You can use the {product-title} `MachineSet` API to manually scale your cluster up to the desired size.
35+
The minimum requirements usually mean that you must scale up one of the default machine sets by two additional machines.
36+
See xref:../../machine_management/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scaling a machine set].
5637

5738
include::modules/serverless-install-web-console.adoc[leveloffset=+1]
5839

0 commit comments

Comments
 (0)