Skip to content

Commit 0489f68

Browse files
committed
[SRVKS-910]: Update new hyphen style config options
1 parent f338726 commit 0489f68

6 files changed

+25
-25
lines changed

modules/serverless-autoscaling-developer-maxscale.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[id="serverless-autoscaling-developer-maxscale_{context}"]
77
= Maximum scale bounds
88

9-
The maximum number of replicas that can serve an application is determined by the `maxScale` annotation. If the `maxScale` annotation is not set, there is no upper limit for the number of replicas created.
9+
The maximum number of replicas that can serve an application is determined by the `max-scale` annotation. If the `max-scale` annotation is not set, there is no upper limit for the number of replicas created.
1010

11-
.Example service spec with `maxScale` annotation
11+
.Example service spec with `max-scale` annotation
1212
[source,yaml]
1313
----
1414
apiVersion: serving.knative.dev/v1
@@ -20,6 +20,6 @@ spec:
2020
template:
2121
metadata:
2222
annotations:
23-
autoscaling.knative.dev/maxScale: "10"
23+
autoscaling.knative.dev/max-scale: "10"
2424
...
2525
----

modules/serverless-autoscaling-developer-minscale.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
[id="serverless-autoscaling-developer-minscale_{context}"]
77
= Minimum scale bounds
88

9-
The minimum number of replicas that can serve an application is determined by the `minScale` annotation. If scale to zero is not enabled, the `minScale` value defaults to `1`.
9+
The minimum number of replicas that can serve an application is determined by the `min-scale` annotation. If scale to zero is not enabled, the `min-scale` value defaults to `1`.
1010

11-
The `minScale` value defaults to `0` replicas if the following conditions are met:
11+
The `min-scale` value defaults to `0` replicas if the following conditions are met:
1212

13-
* The `minScale` annotation is not set
13+
* The `min-scale` annotation is not set
1414
* Scaling to zero is enabled
1515
* The class `KPA` is used
1616
17-
.Example service spec with `minScale` annotation
17+
.Example service spec with `min-scale` annotation
1818
[source,yaml]
1919
----
2020
apiVersion: serving.knative.dev/v1
@@ -26,6 +26,6 @@ spec:
2626
template:
2727
metadata:
2828
annotations:
29-
autoscaling.knative.dev/minScale: "0"
29+
autoscaling.knative.dev/min-scale: "0"
3030
...
3131
----

modules/serverless-autoscaling-maxscale-kn.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-autoscaling-maxscale-kn_{context}"]
7-
= Setting the maxScale annotation by using the Knative CLI
7+
= Setting the max-scale annotation by using the Knative CLI
88

9-
Using the `kn` CLI to set the `maxScale` annotation provides a more streamlined and intuitive user interface over modifying YAML files directly. You can use the `kn service` command with the `--max-scale` flag to create or modify the `--max-scale` value for a service.
9+
Using the Knative (`kn`) CLI to set the `max-scale` annotation provides a more streamlined and intuitive user interface over modifying YAML files directly. You can use the `kn service` command with the `--scale-max` flag to create or modify the `max-scale` value for a service.
1010

1111
.Prerequisites
1212

1313
* Knative Serving is installed on the cluster.
14-
* You have installed the `kn` CLI.
14+
* You have installed the Knative (`kn`) CLI.
1515
1616
.Procedure
1717

18-
* Set the maximum number of replicas for the service by using the `--max-scale` flag:
18+
* Set the maximum number of replicas for the service by using the `--scale-max` flag:
1919
+
2020
[source,terminal]
2121
----
22-
$ kn service create <service_name> --image <image_uri> --max-scale <integer>
22+
$ kn service create <service_name> --image <image_uri> --scale-max <integer>
2323
----
2424
+
2525
.Example command
2626
[source,terminal]
2727
----
28-
$ kn service create example-service --image quay.io/openshift-knative/knative-eventing-sources-event-display:latest --max-scale 10
28+
$ kn service create example-service --image quay.io/openshift-knative/knative-eventing-sources-event-display:latest --scale-max 10
2929
----

modules/serverless-autoscaling-minscale-kn.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@
44

55
:_content-type: PROCEDURE
66
[id="serverless-autoscaling-minscale-kn_{context}"]
7-
= Setting the minScale annotation by using the Knative CLI
7+
= Setting the min-scale annotation by using the Knative CLI
88

9-
Using the `kn` CLI to set the `minScale` annotation provides a more streamlined and intuitive user interface over modifying YAML files directly. You can use the `kn service` command with the `--min-scale` flag to create or modify the `--min-scale` value for a service.
9+
Using the Knative (`kn`) CLI to set the `min-scale` annotation provides a more streamlined and intuitive user interface over modifying YAML files directly. You can use the `kn service` command with the `--scale-min` flag to create or modify the `min-scale` value for a service.
1010

1111
.Prerequisites
1212

1313
* Knative Serving is installed on the cluster.
14-
* You have installed the `kn` CLI.
14+
* You have installed the Knative (`kn`) CLI.
1515
1616
.Procedure
1717

18-
* Set the minimum number of replicas for the service by using the `--min-scale` flag:
18+
* Set the minimum number of replicas for the service by using the `--scale-min` flag:
1919
+
2020
[source,terminal]
2121
----
22-
$ kn service create <service_name> --image <image_uri> --min-scale <integer>
22+
$ kn service create <service_name> --image <image_uri> --scale-min <integer>
2323
----
2424
+
2525
.Example command
2626
[source,terminal]
2727
----
28-
$ kn service create example-service --image quay.io/openshift-knative/knative-eventing-sources-event-display:latest --min-scale 2
28+
$ kn service create example-service --image quay.io/openshift-knative/knative-eventing-sources-event-display:latest --scale-min 2
2929
----
3030
3131
// TODO: Check if it can be used with update and other service commands.

modules/serverless-https-redirect-service.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= HTTPS redirection per service
88

99
// need better details from eng team about use case to update this topic
10-
You can enable or disable HTTPS redirection for a service by configuring the `networking.knative.dev/httpOption` annotation. The following example shows how you can use this annotation in a Knative `Service` YAML object:
10+
You can enable or disable HTTPS redirection for a service by configuring the `networking.knative.dev/http-option` annotation. The following example shows how you can use this annotation in a Knative `Service` YAML object:
1111

1212
[source,yaml]
1313
----
@@ -17,7 +17,7 @@ metadata:
1717
name: example
1818
namespace: default
1919
annotations:
20-
networking.knative.dev/httpOption: "redirected"
20+
networking.knative.dev/http-option: "redirected"
2121
spec:
2222
...
2323
----

modules/serverless-target-utilization.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
This value specifies the percentage of the concurrency limit that is actually targeted by the autoscaler. This is also known as specifying the _hotness_ at which a replica runs, which enables the autoscaler to scale up before the defined hard limit is reached.
1010

11-
For example, if the `containerConcurrency` annotation value is set to 10, and the `targetUtilizationPercentage` value is set to 70 percent, the autoscaler creates a new replica when the average number of concurrent requests across all existing replicas reaches 7. Requests numbered 7 to 10 are still sent to the existing replicas, but additional replicas are started in anticipation of being required after the `containerConcurrency` annotation limit is reached.
11+
For example, if the `containerConcurrency` value is set to 10, and the `target-utilization-percentage` value is set to 70 percent, the autoscaler creates a new replica when the average number of concurrent requests across all existing replicas reaches 7. Requests numbered 7 to 10 are still sent to the existing replicas, but additional replicas are started in anticipation of being required after the `containerConcurrency` value is reached.
1212

13-
.Example service configured using the targetUtilizationPercentage annotation
13+
.Example service configured using the target-utilization-percentage annotation
1414
[source,yaml]
1515
----
1616
apiVersion: serving.knative.dev/v1
@@ -22,6 +22,6 @@ spec:
2222
template:
2323
metadata:
2424
annotations:
25-
autoscaling.knative.dev/targetUtilizationPercentage: "70"
25+
autoscaling.knative.dev/target-utilization-percentage: "70"
2626
...
2727
----

0 commit comments

Comments
 (0)