Skip to content

Commit

Permalink
Update API reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
devOpsHelm committed Oct 10, 2024
1 parent 873d3c3 commit 1bfb154
Showing 1 changed file with 113 additions and 0 deletions.
113 changes: 113 additions & 0 deletions docs/modules/ROOT/pages/api-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<DataStructureConfigState,DataStructureConfigState>>
* <<DataStructureSpec,DataStructureSpec>>
* <<DataStructureStatus,DataStructureStatus>>
* <<DatabaseConfig,DatabaseConfig>>
* <<DurableExecutorServiceConfiguration,DurableExecutorServiceConfiguration>>
* <<EntryListenerConfiguration,EntryListenerConfiguration>>
* <<EventJournal,EventJournal>>
Expand All @@ -51,6 +52,12 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<ExternalConnectivityIngress,ExternalConnectivityIngress>>
* <<ExternalConnectivityRoute,ExternalConnectivityRoute>>
* <<ExternalConnectivityType,ExternalConnectivityType>>
* <<Flow,Flow>>
* <<FlowExternalConnectivityConfiguration,FlowExternalConnectivityConfiguration>>
* <<FlowList,FlowList>>
* <<FlowPhase,FlowPhase>>
* <<FlowSpec,FlowSpec>>
* <<FlowStatus,FlowStatus>>
* <<FullBehaviorSetting,FullBehaviorSetting>>
* <<GCType,GCType>>
* <<GlobalSerializer,GlobalSerializer>>
Expand Down Expand Up @@ -156,6 +163,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<SerializationFilterList,SerializationFilterList>>
* <<Serializer,Serializer>>
* <<ServerSocketEndpointConfig,ServerSocketEndpointConfig>>
* <<SpecAnnotatorLabeler,SpecAnnotatorLabeler>>
* <<SyncConsistencyCheckStrategy,SyncConsistencyCheckStrategy>>
* <<TLS,TLS>>
* <<TieredStore,TieredStore>>
Expand Down Expand Up @@ -470,6 +478,19 @@ m| memberStatuses | Holds status of data structure for each Hazelcast member m|

<<Table of Contents,Back to TOC>>

=== DatabaseConfig



[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| host | Host to database m| string | true | -
m| secretName | Name of the secret that contains DB credentials m| string | true | -
|===

<<Table of Contents,Back to TOC>>

=== DurableExecutorServiceConfiguration


Expand Down Expand Up @@ -597,6 +618,83 @@ m| hostname | Hostname of Management Center exposed by route. Openshift routers

<<Table of Contents,Back to TOC>>

=== Flow

Flow is the Schema for the flows API

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| metadata | &#160; m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta[metav1.ObjectMeta] | false | -
m| spec | &#160; m| <<FlowSpec,FlowSpec>> | false | -
m| status | &#160; m| <<FlowStatus,FlowStatus>> | false | -
|===

<<Table of Contents,Back to TOC>>

=== FlowExternalConnectivityConfiguration

FlowExternalConnectivityConfiguration defines how to expose Flow pods.

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| ingress | Ingress configuration of Flow m| &#42;<<ExternalConnectivityIngress,ExternalConnectivityIngress>> | false | -
m| route | OpenShift Route configuration of Flow m| &#42;<<ExternalConnectivityRoute,ExternalConnectivityRoute>> | false | -
|===

<<Table of Contents,Back to TOC>>

=== FlowList

FlowList contains a list of Flow

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| metadata | &#160; m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta[metav1.ListMeta] | false | -
m| items | &#160; m| []<<Flow,Flow>> | true | -
|===

<<Table of Contents,Back to TOC>>

=== FlowSpec

FlowSpec defines the desired state of Flow

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| size | Number of Flow instances. m| &#42;int32 | false | 3
m| repository | Repository to pull the Flow image from. m| string | false | "quay.io/hazelcast_cloud/hazelcast-flow-internal"
m| version | Version of Flow. m| string | false | "next-v593"
m| imagePullPolicy | Pull policy for the Flow image m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#pullpolicy-v1-core[corev1.PullPolicy] | false | "IfNotPresent"
m| imagePullSecrets | Image pull secrets for the Flow image m| []https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core[corev1.LocalObjectReference] | false | -
m| licenseKeySecretName | Name of the secret with Hazelcast Enterprise License Key. m| string | true | -
m| scheduling | Scheduling details m| &#42;<<SchedulingConfiguration,SchedulingConfiguration>> | false | -
m| resources | Compute Resources required by the Hazelcast container. m| &#42;https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false | -
m| externalConnectivity | Configuration to expose Flow to outside. m| &#42;<<FlowExternalConnectivityConfiguration,FlowExternalConnectivityConfiguration>> | false | {}
m| database | Configuration for Flow database m| <<DatabaseConfig,DatabaseConfig>> | true | -
m| env | Env configuration of environment variables m| []https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#envvar-v1-core[corev1.EnvVar] | false | -
m| annotations | Flow Kubernetes resource annotations m| map[string]string | false | -
m| labels | Flow Kubernetes resource labels m| map[string]string | false | -
|===

<<Table of Contents,Back to TOC>>

=== FlowStatus

FlowStatus defines the observed state of Flow

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| phase | Phase of the Flow m| <<FlowPhase,FlowPhase>> | false | -
m| message | Message about the Flow state m| string | false | -
|===

<<Table of Contents,Back to TOC>>

=== GlobalSerializer

GlobalSerializer is registered as a fallback serializer to handle all other objects if a serializer cannot be located for them.
Expand Down Expand Up @@ -2378,6 +2476,21 @@ m| "LoadBalancer" | ExternalConnectivityTypeLoadBalancer exposes Management Cent

<<Table of Contents,Back to TOC>>

=== FlowPhase

FlowPhase represents the current state of the cluster

[cols="5,10"options="header"]
|===
| Value | Description
m| "Running" | FlowRunning phase is the state when the Flow is successfully started
m| "Failed" | FlowFailed phase is the state of error during the Flow startup
m| "Pending" | FlowPending phase is the state of starting the cluster when the Flow is not started yet
m| "Terminating" | FlowTerminating phase is the state where deletion of Flow and dependent resources happen
|===

<<Table of Contents,Back to TOC>>

=== FullBehaviorSetting


Expand Down

0 comments on commit 1bfb154

Please sign in to comment.