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

Jump to bottom

Update document for HPA #218

Merged
merged 2 commits into from
Mar 1, 2022
Merged

Update document for HPA #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ecf06c
[#217] fix relative links in documentation
jmesnil Feb 16, 2022
40d2fe4
[#211] add api doc for .status.selector field
jmesnil Feb 16, 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
24 changes: 8 additions & 16 deletions doc/apis.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ This document describes the types introduced by the WildFly Operator to be consu
[options="header,footer"]
|=======================
| Field | Description |Scheme| Required
| `metadata` | Standard object's metadata (https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata[more info]) | https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta[metav1.ObjectMeta] | false
| `metadata` | Standard object's metadata (https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata[more info]) | https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta[metav1.ObjectMeta] | false
| `spec` | Specification of the desired behaviour of the WildFly deployment (https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status[more info]) | <<wildflyserverspec>> | true
| `status` | Most recent observed status of the WildFly deployment. Read-only. (https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status#spec-and-status[more info]) | <<wildflyserverstatus>> | false |
| `status` | Most recent observed status of the WildFly deployment. Read-only. (https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status[more info]) | <<wildflyserverstatus>> | false |
|=======================

[[wildflyservelist]]
Expand All @@ -24,7 +24,7 @@ This document describes the types introduced by the WildFly Operator to be consu
[options="header,footer"]
|=======================
| Field | Description |Scheme| Required
| `metadata` | Standard list's metadata (https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata[more info]) | https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#listmeta-v1-meta[metav1.ListMeta] | false
| `metadata` | Standard list's metadata (https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata[more info]) | https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#listmeta-v1-meta[metav1.ListMeta] | false
| `items` | List of `WildFlyServer` | []<<wildflyserver>> | true
|=======================

Expand All @@ -44,7 +44,7 @@ It uses a `StatefulSet` with a pod spec that mounts the volume specified by `sto
| `bootableJar` | BootableJar specifies whether the application image is using WildFly S2I Builder/Runtime images or Bootable Jar. If omitted,
it defaults to false (application image is expected to use WildFly S2I Builder/Runtime images) | bool | false
| `standaloneConfigMap` | spec to specify how standalone configuration can be read from a `ConfigMap` | *<<standaloneconfigmapspec>> |false
| `resources`| Resources spec to specify the request or limits of the Stateful Set. If ommited, the namespace defaults are used. | *<<resources>> | false
| `resources`| Resources spec to specify the request or limits of the Stateful Set. If omitted, the namespace defaults are used (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[more info]). | *<<Resources>> | false
| `storage` | Storage spec to specify how storage should be used. If omitted, an `EmptyDir` is used (that will not persist data across pod restart) | *<<storagespec>> |false
| `serviceAccountName` | Name of the ServiceAccount to use to run the WildFlyServer Pods | string | false
| `envFrom` | List of environment variable present in the containers from source (either `ConfigMap` or `Secret`) | []https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#envfromsource-v1-core[corev1.EnvFromSource] |false
Expand All @@ -55,20 +55,11 @@ it defaults to false (application image is expected to use WildFly S2I Builder/R
| `sessionAffinity`| If connections from the same client IP are passed to the same WildFlyServer instance/pod each time (false if omitted) | bool | false
|=======================

[[resources]]
[[Resources]]
## `Resources`

`Resources` defines the configured resources for a `WildflyServer` resources. If the resource is not defined or `Request` or `Limits` is empty this resources will removed from the `Stateful Set`
The description of this resource is a standard `Container` resource and is the same as the kubernetes api found on kubernetes.

This resource is not limited to only cpu and memory for more information on container resources:
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

[options="header,footer"]
|=======================
| Field | Description |Scheme| Required
| `resources` | ResourceRequirements describes the compute resource requirements. | https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false
|=======================
`Resources` defines the configured resources for a `WildflyServer` resource. If the `Resources` field is not defined or `Request` or `Limits` is empty, this resource is removed from the `StatefulSet`
The description of this resource is a standard `Container` resource and uses the scheme for https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#resourcerequirements-v1-core[corev1.ResourceRequirements].

[[storagespec]]
## `StorageSpec`
Expand Down Expand Up @@ -109,6 +100,7 @@ transaction, make sure to specify a `volumeClaimTemplate` that so that the same
|=======================
| Field | Description |Scheme| Required
| `replicas` | Replicas is the actual number of replicas for the application | int32 | true
| `selector` | selector for pods, used by HorizontalPodAutoscaler | string | true
| `hosts` | Hosts that route to the application HTTP service | []string | true
| `pods` | Status of the pods | []<<podstatus>> | true
| `scalingdownPods` | Number of pods which are under scale down cleaning process | int32 | true
Expand Down
6 changes: 3 additions & 3 deletions doc/user-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This guide documents the various features and capabilites provides by the WildFly Operator.

This guide is complemented by the link:../apis.adoc[API Documentation].
This guide is complemented by the link:./apis.adoc[API Documentation].

[[basic-install]]
# Basic Install (Phase I)
Expand Down Expand Up @@ -71,7 +71,7 @@ spec:
[[resources]]
## Specify the Resource requirements for the container

The `resources` spec is defined in the link:../apis.adoc#Resources[Resources API Documentation].
The `resources` spec is defined in the link:./apis.adoc#Resources[Resources API Documentation].

[source,yaml]
.Example of resources configuration
Expand Down Expand Up @@ -110,7 +110,7 @@ link:https://docs.wildfly.org/23/wildscribe/subsystem/transactions/index.html#at
A `volumeClaimTemplate` cna be specifed to configure `Resources` requirements to store WildFly standalone data directory.
The name of the template is derived from the `WildFlyServer` name. The corresponding volume will be mounted in `ReadWriteOnce` access mode.

The `storage` spec is defined in the link:../apis.adoc#StorageSpec[StorageSpec API Documentation].
The `storage` spec is defined in the link:./apis.adoc#StorageSpec[StorageSpec API Documentation].

[source,yaml]
.Example of storage requirement
Expand Down