Review and update descriptions for schema #1772
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rjeberhard
requested review from
alai8,
russgold,
mriccell,
ddsharpe,
rosemarymarano and
tbarnes-us
tbarnes-us
reviewed
Jun 26, 2020
tbarnes-us
reviewed
Jun 26, 2020
docs/domains/Domain.json
Outdated
| "type": "string", | ||
| "enum": [ | ||
| "RUNNING", | ||
| "ADMIN" | ||
| ] | ||
| }, | ||
| "serverService": { | ||
| "description": "Customization affecting ClusterIP Kubernetes services for WebLogic Server instances.", | ||
| "description": "Customization affecting the generation of Kubernetes services for WebLogic Server instances.", |
There was a problem hiding this comment.
Kubernetes services -> Kubernetes Services (Kubernetes Service is a resource name)
docs/domains/Domain.json
Outdated
| "$ref": "#/definitions/ServerPod" | ||
| }, | ||
| "serverStartPolicy": { | ||
| "description": "The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED.", | ||
| "description": "The strategy for deciding whether to start a WebLogic server instance. Legal values are ALWAYS, NEVER, or IF_NEEDED. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers", |
There was a problem hiding this comment.
WebLogic server instance -> WebLogic Server instance
docs/domains/Domain.json
Outdated
| @@ -181,23 +177,23 @@ | |||
| "type": "object", | |||
| "properties": { | |||
| "overrideDistributionStrategy": { | |||
| "description": "Determines how updated configuration overrides are distributed to already running WebLogic servers following introspection when the domainHomeSourceType is PersistentVolume or Image. Configuration overrides are generated during introspection from secrets, the overrideConfigMap field, and WebLogic domain topology. Legal values are DYNAMIC (the default) and ON_RESTART. See also introspectVersion.", | |||
| "description": "Determines how updated configuration overrides are distributed to already running WebLogic servers following introspection when the domainHomeSourceType is PersistentVolume or Image. Configuration overrides are generated during introspection from secrets, the overrideConfigMap field, and WebLogic domain topology. Legal values are DYNAMIC and ON_RESTART. See also introspectVersion. Defaults to DYNAMIC.", | |||
There was a problem hiding this comment.
WebLogic servers -> WebLogic Servers
docs/domains/Domain.json
Outdated
| @@ -250,13 +246,13 @@ | |||
| "$ref": "#/definitions/DateTime" | |||
| }, | |||
| "status": { | |||
| "description": "Status is the status of the condition. Can be True, False, Unknown. Required.", | |||
| "description": "Status is the status of the condition. Can be True, False, Unknown.", | |||
There was a problem hiding this comment.
Status is the status of the condition. -> The status of the condition.
docs/domains/Domain.json
Outdated
| "type": "boolean" | ||
| }, | ||
| "webLogicCredentialsSecret": { | ||
| "description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namespace, that holds the username and password needed to boot WebLogic Server under the \u0027username\u0027 and \u0027password\u0027 fields.", | ||
| "description": "Reference to a Kubernetes Secret that contains the username and password needed to boot a WebLogic Server under the \u0027username\u0027 and \u0027password\u0027 fields.", |
docs/domains/Domain.md
Outdated
| | `tolerations` | array of [Toleration](k8s1.13.5.md#toleration) | If specified, the pod's tolerations. | | ||
| | `volumeMounts` | array of [Volume Mount](k8s1.13.5.md#volume-mount) | Additional volume mounts for the server pod. | | ||
| | `volumes` | array of [Volume](k8s1.13.5.md#volume) | Additional volumes to be created in the server pod. | | ||
| | `priorityClassName` | string | If specified, indicates the Pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. | |
There was a problem hiding this comment.
be default or zero if there is no default. -> be the default or zero, if there is no default.
docs/domains/Domain.md
Outdated
| | `volumeMounts` | array of [Volume Mount](k8s1.13.5.md#volume-mount) | Additional volume mounts for the server pod. | | ||
| | `volumes` | array of [Volume](k8s1.13.5.md#volume) | Additional volumes to be created in the server pod. | | ||
| | `priorityClassName` | string | If specified, indicates the Pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. | | ||
| | `readinessGates` | array of [Pod Readiness Gate](k8s1.13.5.md#pod-readiness-gate) | If specified, all readiness gates will be evaluated for Pod readiness. A Pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md | |
There was a problem hiding this comment.
have status equal -> have a status equal
docs/domains/Domain.md
Outdated
| | `resources` | [Resource Requirements](k8s1.13.5.md#resource-requirements) | Memory and CPU minimum requirements and limits for the WebLogic Server instance. | | ||
| | `restartPolicy` | string | Restart policy for all containers within the Pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy | | ||
| | `runtimeClassName` | string | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this Pod. If no RuntimeClass resource matches the named class, the Pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://github.com/kubernetes/community/blob/master/keps/sig-node/0014-runtime-class.md This is an alpha feature and may change in the future. | | ||
| | `schedulerName` | string | If specified, the Pod will be dispatched by specified scheduler. If not specified, the Pod will be dispatched by default scheduler. | |
There was a problem hiding this comment.
by specified scheduler -> by the specified scheduler
by default scheduler -> by the default scheduler
docs/domains/Domain.md
Outdated
| @@ -172,56 +162,56 @@ ServerPod describes the configuration for a Kubernetes pod for a server. | |||
| | `lastTransitionTime` | DateTime | Last time the condition transitioned from one status to another. | | |||
| | `message` | string | Human-readable message indicating details about last transition. | | |||
| | `reason` | string | Unique, one-word, CamelCase reason for the condition's last transition. | | |||
| | `status` | string | Status is the status of the condition. Can be True, False, Unknown. Required. | | |||
| | `type` | string | The type of the condition. Valid types are Progressing, Available, and Failed. Required. | | |||
| | `status` | string | Status is the status of the condition. Can be True, False, Unknown. | | |||
There was a problem hiding this comment.
Status is the status of the condition. -> The status of the condition.
docs/domains/index.html
Outdated
| "$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.13.5/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" | ||
| }, | ||
| "apiVersion": { | ||
| "description": "The API version for the Domain.", | ||
| "description": "The API version defines the versioned schema of this representation of a Domain.", |
tbarnes-us
reviewed
Jun 26, 2020
tbarnes-us
reviewed
Jun 26, 2020
tbarnes-us
reviewed
Jun 26, 2020
tbarnes-us
reviewed
Jun 26, 2020
tbarnes-us
reviewed
Jun 26, 2020
|
Okay, @rosemarymarano and @tbarnes-us, I believe that I've responded to all of the comments. Thanks! Can you please review again? |
rosemarymarano
approved these changes
Jun 29, 2020
docs/domains/Domain.md
Outdated
| | `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are ADMIN_ONLY, NEVER, or IF_NEEDED. | | ||
| | `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. | | ||
| | `webLogicCredentialsSecret` | [Secret Reference](k8s1.13.5.md#secret-reference) | The name of a pre-created Kubernetes secret, in the domain's namespace, that holds the username and password needed to boot WebLogic Server under the 'username' and 'password' fields. | | ||
| | `dataHome` | string | An optional, directory in a server's container for data storage of default and custom file stores. If `dataHome` is not specified or its value is either not set or empty then the data storage directories are determined from the WebLogic domain configuration. | |
There was a problem hiding this comment.
An optional, directory -> An optional directory (no comma needed here)
empty then -> empty, then (comma needed here for the if..., then... construct)
docs/domains/Domain.md
Outdated
| | `logHomeEnabled` | Boolean | Specifies whether the log home folder is enabled. Defaults to true if `domainHomeSourceType` is PersistentVolume; false, otherwise. | | ||
| | `managedServers` | array of [Managed Server](#managed-server) | Lifecycle options for individual Managed Servers, including Java options, environment variables, additional Pod content, and the ability to explicitly start, stop, or restart a named server instance. The `serverName` field of each entry must match a Managed Server that already exists in the WebLogic domain configuration or that matches a dynamic cluster member based on the server template. | | ||
| | `maxClusterConcurrentStartup` | number | The maximum number of cluster member Managed Server instances that the operator will start in parallel for a given cluster, if `maxConcurrentStartup` is not specified for a specific cluster under the `clusters` field. A value of 0 means there is no configured limit. Defaults to 0. | | ||
| | `replicas` | number | The default number of cluster member Managed Server instances to start for each WebLogic cluster in the domain configuration, unless `replicas` is specified for that cluster under the `clusters` field. For each cluster, the operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as "managed-server10" come after "managed-server9". The operator will then start Managed Servers from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Servers will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their entries under `managedServers` then a cluster may have more cluster members running than its `replicas` count. Defaults to 0. | |
There was a problem hiding this comment.
under managedServers then -> under managedServers, then (comma before then)
docs/domains/Domain.md
Outdated
| | `serverPod` | [Server Pod](#server-pod) | Customization affecting the generation of Pods for WebLogic Server instances. | | ||
| | `serverService` | [Server Service](#server-service) | Customization affecting the generation of Kubernetes Services for WebLogic Server instances. | | ||
| | `serverStartPolicy` | string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are ADMIN_ONLY, NEVER, or IF_NEEDED. Defaults to IF_NEEDED. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. | | ||
| | `serverStartState` | string | The WebLogic runtime state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. | |
There was a problem hiding this comment.
Use ADMIN if server should start -> Use ADMIN if the server should start
docs/domains/Domain.md
Outdated
| | `volumeMounts` | array of [Volume Mount](k8s1.13.5.md#volume-mount) | Additional volume mounts for the server pod. | | ||
| | `volumes` | array of [Volume](k8s1.13.5.md#volume) | Additional volumes to be created in the server pod. | | ||
| | `priorityClassName` | string | If specified, indicates the Pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be the default or zero, if there is no default. | | ||
| | `readinessGates` | array of [Pod Readiness Gate](k8s1.13.5.md#pod-readiness-gate) | If specified, all readiness gates will be evaluated for Pod readiness. A Pod is ready when all its containers are ready AND all conditions specified in the readiness gates have a status equal to "True" More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md. | |
There was a problem hiding this comment.
to "True" More info: -> to "True". More info: (missing period)
|
@rosemarymarano, thanks for the offer, but I'll make the changes. It's a bit of a pain, unfortunately, because the source is actually the Java code and then you have to build to update these files. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note to reviewers: the Java code is the source for all of these descriptions. Please feel free to put comments in the *.md, *.yaml, or *.java files, but it is not required that you comment on the same string values more than once.