RazeeDeployment/v1alpha1
RazeeDeployment is the resources that deploys Razee for the Red Hat Marketplace. This is an internal resource not meant to be modified directly.
apiVersion
Description: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Type: string
| Property | Type | Description |
|---|---|---|
| apiVersion | string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kind
Description: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Type: string
| Property | Type | Description |
|---|---|---|
| kind | string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata
Description: (No Description)
Type: object
| Property | Type | Description |
|---|---|---|
| metadata | object | (No Description) |
spec
Description: RazeeDeploymentSpec defines the desired state of RazeeDeployment
Type: object
| Property | Type | Description |
|---|---|---|
| spec | object | RazeeDeploymentSpec defines the desired state of RazeeDeployment |
| spec.childUrl | string | Location of your IBM Cloud Object Storage resources Used internally by the Operator |
| spec.clusterDisplayName | string | The ClusterDisplayName is a unique name of for a cluster specified by the admin during registration |
| spec.clusterUUID | string | ClusterUUID is the cluster identifier, used for installing razee. |
| spec.deployConfig | object | Configuration values provided from redhat marketplace These are used internally by the Operator |
| spec.deployConfig.bucketName | string | BucketName is the name of the bucket in Cloud Object Storage and correlates to your accountID |
| spec.deployConfig.childRRS3FileName | string | The file name of the child RemoteResourecS3 |
| spec.deployConfig.fileSourceUrl | string | FileSourceURL DEPRECATED: The url of the filesource arg that gets passed into the razeedeploy-job |
| spec.deployConfig.ibmCosReaderKey | object | Api key used to access the bucket IBM COS |
| spec.deployConfig.ibmCosReaderKey.key | string | The key of the secret to select from. Must be a valid secret key. |
| spec.deployConfig.ibmCosReaderKey.name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
| spec.deployConfig.ibmCosReaderKey.optional | boolean | Specify whether the Secret or its key must be defined |
| spec.deployConfig.ibmCosUrl | string | Base url for the instance of IBM COS |
| spec.deployConfig.razeeDashOrgKey | object | Key used to identify a particular razee instance |
| spec.deployConfig.razeeDashOrgKey.key | string | The key of the secret to select from. Must be a valid secret key. |
| spec.deployConfig.razeeDashOrgKey.name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
| spec.deployConfig.razeeDashOrgKey.optional | boolean | Specify whether the Secret or its key must be defined |
| spec.deployConfig.razeeDashUrl | string | Url used by the razee install to post data |
| spec.deploySecretName | string | DeploySecretName is the name of our secret where Razee variables are stored. |
| spec.enabled | boolean | Enabled is the flag that controls if the controller does work. Setting enabled to true will create a Razee namespace and deploy it’s components. Set to false to bypass Razee installation |
| spec.features | object | The features that can be enabled or disabled |
| spec.features.deployment | boolean | Deployment represents the enablement of the razee deployment, defaults to true when not set |
| spec.features.meterDefinitionCatalogServer | boolean | EnableMeterDefinitionCatalogServer represents the enablement of the meterdefinition catalog server, defaults to true when not set |
| spec.features.registration | boolean | Registration represents the enablement of the registration watchkeeper deployment, defaults to true when not set |
| spec.installIBMCatalogSource | boolean | InstallIBMCatalogSource is the flag that indicates if the IBM Catalog Source is installed |
| spec.legacyUninstallHasRun | boolean | Flag used by the RazeeDeployment Controller to decide whether to run legacy uninstall job Used internally by the Operator |
| spec.targetNamespace | string | TargetNamespace is configurable target of the razee namespace This is to support legancy installs. Please do not edit. |
status
Description: RazeeDeploymentStatus defines the observed state of RazeeDeployment
Type: object
| Property | Type | Description |
|---|---|---|
| status | object | RazeeDeploymentStatus defines the observed state of RazeeDeployment |
| status.conditions | object | JobConditions DEPRECATED: represent the latest available observations of an object’s stateonfig |
| status.conditions.lastProbeTime | string | Last time the condition was checked. |
| status.conditions.lastTransitionTime | string | Last time the condition transit from one status to another. |
| status.conditions.message | string | Human readable message indicating details about last transition. |
| status.conditions.reason | string | (brief) reason for the condition’s last transition. |
| status.conditions.status | string | Status of the condition, one of True, False, Unknown. |
| status.conditions.type | string | Type of job condition, Complete or Failed. |
| status.installConditions | array | RazeeConditions represent the latest available observations of an object’s stateonfig |
| status.jobState | object | JobState DEPRECATED: is the status of the Razee Install Job |
| status.jobState.active | integer | The number of pending and running pods. |
| status.jobState.completedIndexes | string | CompletedIndexes holds the completed indexes when .spec.completionMode = “Indexed” in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as “1,3-5,7”. |
| status.jobState.completionTime | string | Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully. |
| status.jobState.conditions | array | The latest available observations of an object’s current state. When a Job fails, one of the conditions will have type “Failed” and status true. When a Job is suspended, one of the conditions will have type “Suspended” and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type “Complete” and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
| status.jobState.failed | integer | The number of pods which reached phase Failed. |
| status.jobState.ready | integer | The number of pods which have a Ready condition. This field is beta-level. The job controller populates the field when the feature gate JobReadyPods is enabled (enabled by default). |
| status.jobState.startTime | string | Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC. |
| status.jobState.succeeded | integer | The number of pods which reached phase Succeeded. |
| status.jobState.uncountedTerminatedPods | object | UncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn’t yet accounted for in the status counters. The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status: (1) Add the pod UID to the arrays in this field. (2) Remove the pod finalizer. (3) Remove the pod UID from the arrays while increasing the corresponding counter. Old jobs might not be tracked using this field, in which case the field remains null. |
| status.jobState.uncountedTerminatedPods.failed | array | Failed holds UIDs of failed Pods. |
| status.jobState.uncountedTerminatedPods.succeeded | array | Succeeded holds UIDs of succeeded Pods. |
| status.localSecretVarsPopulated | boolean | LocalSecretVarsPopulated DEPRECATED: informs if the correct local variables are correct set. |
| status.missingValuesFromSecret | array | MissingValuesFromSecret validates the secret provided has all the correct fields |
| status.nodesFromRazeeDeployments | array | NodesFromRazeeDeployments contains the pods names created by the rhm-watch-keeper and rhm-remote-resources3-controller deployments |
| status.nodesFromRazeeDeploymentsCount | integer | NodesFromRazeeDeploymentsCount contains the pods names created by the rhm-watch-keeper and rhm-remote-resources3-controller deployments |
| status.razee_job_install | object | RazeeJobInstall contains information regarding the install job so it can be removed |
| status.razee_job_install.razee_install_url | string | RazeeInstallURL is the url used to install the Razee resources |
| status.razee_job_install.razee_namespace | string | RazeeNamespace is the namespace targeted for the Razee install |
| status.razeePrerequisitesCreated | array | RazeePrerequestesCreated is the list of configmaps and secrets required to be installed |
| status.redHatMarketplaceSecretFound | boolean | RedHatMarketplaceSecretFound DEPRECATED: is the status of finding the secret in the cluster |