From e670f3d0b9ffd2b5188b9fb17b111bb89c46c383 Mon Sep 17 00:00:00 2001 From: SRE Service Date: Tue, 3 Sep 2024 16:25:46 -0700 Subject: [PATCH] CDP Beta API Documentation 0.9.121 --- api-docs-beta/CHANGELOG.md | 18 + api-docs-beta/README.md | 40 +- api-docs-beta/audit/index.html | 4 +- api-docs-beta/cloudprivatelinks/index.html | 4 +- api-docs-beta/compute/index.html | 1985 +++-------------- api-docs-beta/consumption/index.html | 4 +- api-docs-beta/datacatalog/index.html | 4 +- api-docs-beta/datahub/index.html | 4 +- api-docs-beta/datalake/index.html | 4 +- api-docs-beta/de/index.html | 488 +++- api-docs-beta/df/index.html | 4 +- api-docs-beta/dfworkload/index.html | 4 +- api-docs-beta/drscp/index.html | 4 +- api-docs-beta/dw/index.html | 330 +-- api-docs-beta/environments/index.html | 4 +- api-docs-beta/iam/index.html | 4 +- api-docs-beta/imagecatalog/index.html | 4 +- api-docs-beta/metrics/index.html | 4 +- api-docs-beta/ml/index.html | 202 +- api-docs-beta/opdb/index.html | 87 +- api-docs-beta/replicationmanager/index.html | 4 +- api-docs-beta/swagger/README.md | 40 +- api-docs-beta/swagger/audit.yaml | 2 +- api-docs-beta/swagger/cloudprivatelinks.yaml | 2 +- api-docs-beta/swagger/compute.yaml | 342 +-- api-docs-beta/swagger/consumption.yaml | 2 +- api-docs-beta/swagger/datacatalog.yaml | 2 +- api-docs-beta/swagger/datahub.yaml | 2 +- api-docs-beta/swagger/datalake.yaml | 2 +- api-docs-beta/swagger/de.yaml | 126 +- api-docs-beta/swagger/df.yaml | 2 +- api-docs-beta/swagger/dfworkload.yaml | 2 +- api-docs-beta/swagger/drscp.yaml | 2 +- api-docs-beta/swagger/dw.yaml | 73 +- api-docs-beta/swagger/environments.yaml | 2 +- api-docs-beta/swagger/iam.yaml | 2 +- api-docs-beta/swagger/imagecatalog.yaml | 2 +- api-docs-beta/swagger/metrics.yaml | 2 +- api-docs-beta/swagger/ml.yaml | 159 +- api-docs-beta/swagger/opdb.yaml | 25 +- api-docs-beta/swagger/replicationmanager.yaml | 2 +- 41 files changed, 1404 insertions(+), 2595 deletions(-) diff --git a/api-docs-beta/CHANGELOG.md b/api-docs-beta/CHANGELOG.md index eea407159..2a18fa42f 100644 --- a/api-docs-beta/CHANGELOG.md +++ b/api-docs-beta/CHANGELOG.md @@ -1,5 +1,23 @@ # CDP Control Plane Public API Changelog +## 0.9.121 (2024-09-03) +* de: Add new property `sparkConfigs` to `VcDescription` object. +* de: Add `sparkConfigs` parameter to `createVc` and `updateVc` commands. +* de: Add new commands `upgradeService` and `getUpgradeStatus`. +* de: Add new properties `azureFilesharePrivateDNSZoneId` and `azureDatabasePrivateDNSZoneId` to `enableService` command. +* dw: Remove deprecation tag from `computeInstanceType` parameter in `createAwsCluster` and `createAzureCluster` commands. +* dw: Remove deprecation tag from `computeInstanceType` property in `AwsActivationOptions` and `AzureActivationOptions` objects. +* dw: Remove deprecation tag from `computeInstanceType` field in the response of `clusterSummary` command. +* ml: Add new commands `addInstanceGroupsMlServingApp`, `createMlServingApp`, `deleteInstanceGroupMlServingApp`, `deleteMlServingApp`, `describeMlServingApp`, `getMlServingAppKubeconfig`, `grantMlServingAppAccess`, `listInstanceTypeConfiguration`, `listMlServingAppAccess`, `listMlServingApps`, `listRelevantInstances`, `modifyMlServingApp`, `revokeMlServingAppAccess`, and `upgradeMlServingApp`. +* opdb: Update description of `StorageType` object. +* opdb: Add new command `updateDatabase`. + +BACKWARD INCOMPATIBILITIES: +* dw: Remove `Docker` value from enum `registryType` in `CustomRegistryOptions` object. +* dw: Remove `userName`, `password`, and `disableImageVerification` properties from `CustomRegistryOptions` object. +* dw: Remove `upgradeCluster` command. + + ## 0.9.120 (2024-08-14) * datalake: Add `rangerCloudAccessAuthorizerRole` parameter to `validate-aws-cloud-storage` command. * datalake: Add new property `dryRunValidation` to `AdminOperationsBackupRestoreState` object. diff --git a/api-docs-beta/README.md b/api-docs-beta/README.md index eb99294bd..30d3dc14a 100644 --- a/api-docs-beta/README.md +++ b/api-docs-beta/README.md @@ -1,30 +1,30 @@ # CDP Control Plane Public API Documentation -*Version: 0.9.120 (BETA)* +*Version: 0.9.121 (BETA)* Available documentation is listed by service below. | Service | Version | | --- | --- | -| [audit](./audit/index.html) | 0.9.120 | -| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.120 | -| [compute](./compute/index.html) | 0.9.120 | -| [consumption](./consumption/index.html) | 0.9.120 | -| [datacatalog](./datacatalog/index.html) | 0.9.120 | -| [datahub](./datahub/index.html) | 0.9.120 | -| [datalake](./datalake/index.html) | 0.9.120 | -| [de](./de/index.html) | 0.9.120 | -| [df](./df/index.html) | 0.9.120 | -| [dfworkload](./dfworkload/index.html) | 0.9.120 | -| [drscp](./drscp/index.html) | 0.9.120 | -| [dw](./dw/index.html) | 0.9.120 | -| [environments](./environments/index.html) | 0.9.120 | -| [iam](./iam/index.html) | 0.9.120 | -| [imagecatalog](./imagecatalog/index.html) | 0.9.120 | -| [metrics](./metrics/index.html) | 0.9.120 | -| [ml](./ml/index.html) | 0.9.120 | -| [opdb](./opdb/index.html) | 0.9.120 | -| [replicationmanager](./replicationmanager/index.html) | 0.9.120 | +| [audit](./audit/index.html) | 0.9.121 | +| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.121 | +| [compute](./compute/index.html) | 0.9.121 | +| [consumption](./consumption/index.html) | 0.9.121 | +| [datacatalog](./datacatalog/index.html) | 0.9.121 | +| [datahub](./datahub/index.html) | 0.9.121 | +| [datalake](./datalake/index.html) | 0.9.121 | +| [de](./de/index.html) | 0.9.121 | +| [df](./df/index.html) | 0.9.121 | +| [dfworkload](./dfworkload/index.html) | 0.9.121 | +| [drscp](./drscp/index.html) | 0.9.121 | +| [dw](./dw/index.html) | 0.9.121 | +| [environments](./environments/index.html) | 0.9.121 | +| [iam](./iam/index.html) | 0.9.121 | +| [imagecatalog](./imagecatalog/index.html) | 0.9.121 | +| [metrics](./metrics/index.html) | 0.9.121 | +| [ml](./ml/index.html) | 0.9.121 | +| [opdb](./opdb/index.html) | 0.9.121 | +| [replicationmanager](./replicationmanager/index.html) | 0.9.121 | API documentation uses the Adoc Riak stylesheet from [https://github.com/darshandsoni/asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins). diff --git a/api-docs-beta/audit/index.html b/api-docs-beta/audit/index.html index 4276f9101..db5b775a8 100644 --- a/api-docs-beta/audit/index.html +++ b/api-docs-beta/audit/index.html @@ -822,7 +822,7 @@

Overview

Version information

-

Version : 0.9.120 (BETA)

+

Version : 0.9.121 (BETA)

@@ -3910,7 +3910,7 @@

MarkArchiveBatchesAsSuccessfulR


diff --git a/api-docs-beta/cloudprivatelinks/index.html b/api-docs-beta/cloudprivatelinks/index.html index f9a42d19f..87e089eeb 100644 --- a/api-docs-beta/cloudprivatelinks/index.html +++ b/api-docs-beta/cloudprivatelinks/index.html @@ -775,7 +775,7 @@

Overview

Version information

-

Version : 0.9.120 (BETA)

+

Version : 0.9.121 (BETA)

@@ -2734,7 +2734,7 @@

RevokePrivateLinkServiceAccessRes


diff --git a/api-docs-beta/compute/index.html b/api-docs-beta/compute/index.html index f4910f41c..c38fc155b 100644 --- a/api-docs-beta/compute/index.html +++ b/api-docs-beta/compute/index.html @@ -859,43 +859,28 @@

Cloudera Compute Service

  • AzurePrerequisiteDetail
  • Chart
  • CommonAccelerator
    • -
  • CommonAlertmanager
  • CommonAlertmanagerResp
  • CommonApiServer
  • CommonApiServerResp
  • CommonAutoScaling
  • CommonAutoscaler
  • CommonAutoscalerResp
    • -
  • CommonClusterMetadata
    • -
  • CommonClusterOwner
    • -
  • CommonClusterSpec
  • CommonDeploymentProfileDetailsResp
    • -
  • CommonDeployments
  • CommonDeploymentsResp
  • CommonEvent
  • CommonHelm
    • -
  • CommonHorizontalPodAutoScaler
  • CommonHorizontalPodAutoScalerResp
  • CommonImageCatalog
  • CommonImageCatalogResp
  • CommonInstanceGroup
  • CommonInstanceStateCounts
    • -
  • CommonIstio
    • -
  • CommonKubernetes
    • -
  • CommonLogging
  • CommonLoggingResp
    • -
  • CommonMetering
  • CommonMeteringResp
    • -
  • CommonMeteringService
  • CommonMeteringServiceResp
    • -
  • CommonMonitoring
  • CommonMonitoringResp
  • CommonNetwork
    • -
  • CommonNetworkTopology
  • CommonNodeImageAvailableUpgrade
    • -
  • CommonNvidia
  • CommonNvidiaResp
    • -
  • CommonResourceLimit
  • CommonResourceLimitsResp
  • CommonRootVolume
  • CommonSecretEncryption
    • @@ -910,7 +895,6 @@

    Cloudera Compute Service

  • CommonUpdateClusterSpec
  • CommonVolumeEncryption
  • CommonVolumeEncryptionResp
    • -
  • CommonYuniKorn
  • CommonYuniKornResp
  • ComputeClusterOwner
  • ComputeClusterType
    • @@ -984,7 +968,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -4173,40 +4157,6 @@

    CommonAccelerator

    -

    CommonAlertmanager

    -
    -

    Alertmanager request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    enabled
    -optional

    -
    -

    Flag to enable alertmanager.

    -
    -

    boolean

    -
    -
    -

    CommonAlertmanagerResp

    Alertmanager response structure.

    @@ -4723,9 +4673,9 @@

    CommonAutoscalerResp

    -

    CommonClusterMetadata

    +

    CommonDeploymentProfileDetailsResp

    -

    Cluster metadata structure. Deprecated.

    +

    Deployment Profile details response structure.

    @@ -4743,153 +4693,153 @@

    CommonClusterMetadata

    + +
    -

    clusterOwner
    +

    deploymentProfile
    optional
    -

    Cluster owner.

    +

    Deployment profile used. Currently supported is common.
    -

    CommonClusterOwner

    +

    string
    -

    clusterType
    +

    enabled
    optional
    -

    Cluster type. Default is Shared.

    +

    Deployment enable flag.
    -

    string

    +

    boolean
    +
    +
    +

    CommonDeploymentsResp

    +
    +

    Deployments response structure.

    +
    + +++++ + + + + + + + + - -
    NameDescriptionSchema
    -

    description
    +

    autoscaler
    optional
    -

    Cluster description.

    +

    Autoscaler specs.
    -

    string

    +

    CommonAutoscalerResp
    -

    environmentCrn
    +

    horizontalPodAutoscaler
    optional
    -

    Environment CRN.

    +

    Horizontal pod autoscaler specs.
    -

    string

    +

    CommonHorizontalPodAutoScalerResp
    -

    labels
    +

    istio
    optional
    -

    Labels.

    +

    Istio specs.
    -

    < string, string > map

    +

    CommonDeploymentProfileDetailsResp
    -

    name
    +

    knox
    optional
    -

    Cluster name.

    +

    Knox specs.
    -

    string

    +

    CommonDeploymentProfileDetailsResp
    -

    workloads
    +

    logging
    optional
    -

    Cluster workloads.

    +

    Logging specs.
    -

    < string > array

    +

    CommonLoggingResp
    -
    -
    -

    CommonClusterOwner

    -
    -

    Cluster owner structure. Deprecated.

    -
    - ----- - - - - - - - -
    NameDescriptionSchema
    -

    accountId
    +

    metering
    optional
    -

    Owner’s account ID.

    +

    Metering specs.
    -

    string

    +

    CommonMeteringResp
    -

    crn
    +

    monitoring
    optional
    -

    Owner’s actor CRN.

    +

    Monitoring specs.
    -

    string

    +

    CommonMonitoringResp
    -

    email
    +

    nvidia
    optional
    -

    Owner’s email.

    +

    Nvidia specs.
    -

    string

    +

    CommonNvidiaResp
    -

    firstName
    +

    repository
    optional
    -

    Owner’s firstname.

    +

    Repository for images.

    string

    @@ -4897,11 +4847,11 @@

    CommonClusterOwner

    -

    lastName
    +

    telemetryKmsKeyArn
    optional
    -

    Owner’s lastname.

    +

    Telemetry KMS key ARN.

    string

    @@ -4909,23 +4859,23 @@

    CommonClusterOwner

    -

    userId
    +

    yunikorn
    optional
    -

    Owner’s user ID.

    +

    Yunikorn specs.
    -

    string

    +

    CommonYuniKornResp
    -

    CommonClusterSpec

    +

    CommonEvent

    -

    Cluster spec request structure. Deprecated.

    +

    Event response structure.

    @@ -4943,11 +4893,11 @@

    CommonClusterSpec

    - - - - - - - - - - + +
    -

    bootstrapScript
    +

    details
    optional
    -

    Bootstrap script.

    +

    Details.

    string

    @@ -4955,83 +4905,59 @@

    CommonClusterSpec

    -

    deployments
    -optional

    -
    -

    Deployments.

    -
    -

    CommonDeployments

    -
    -

    imageCatalog
    -optional

    -
    -

    The image catalog details.

    -
    -

    CommonImageCatalog

    -
    -

    instanceGroups
    +

    name
    optional
    -

    Instance groups.

    +

    Event name.
    -

    < CommonInstanceGroup > array

    +

    string
    -

    kubernetes
    +

    progress
    optional
    -

    K8s details.

    +

    Progress.
    -

    CommonKubernetes

    +

    string
    -

    network
    +

    resourceType
    optional
    -

    Network.

    +

    Resource type.
    -

    CommonNetwork

    +

    string
    -

    security
    +

    status
    optional
    -

    Security.

    +

    Status.
    -

    CommonSecurity

    +

    string
    -

    sshKeypairName
    +

    statusReason
    optional
    -

    SSH keypair.

    +

    Status reason.

    string

    @@ -5039,47 +4965,57 @@

    CommonClusterSpec

    -

    storage
    +

    timestamp
    optional
    -

    The storage specifications.

    +

    Timestamp.
    -

    CommonStorageSpec

    +

    string
    +
    +
    +

    CommonHelm

    +
    +

    Helm structure.

    +
    + +++++ + - - - + + + + +
    -

    workerEgressRules
    -optional

    -
    -

    Array of egress rules of the form protocol:fromPort[:toPort[:CIDR]].

    -
    -

    < string > array

    -
    		NameDescriptionSchema
    -

    workerIngressRules
    +

    version
    optional
    -

    Array of ingress rules of the form protocol:fromPort[:toPort[:CIDR]].

    +

    Helm version to be upgraded to.
    -

    < string > array

    +

    string
    -

    CommonDeploymentProfileDetailsResp

    +

    CommonHorizontalPodAutoScalerResp

    -

    Deployment Profile details response structure.

    +

    Horizontal pod autoscaler response structure.

    @@ -5097,23 +5033,11 @@

    CommonDeploymentProfileDetailsResp<

    - - - - -
    -

    deploymentProfile
    -optional

    -
    -

    Deployment profile used. Currently supported is common.

    -
    -

    string

    -

    enabled
    optional
    -

    Deployment enable flag.

    +

    Enable flag.

    boolean

    @@ -5123,9 +5047,9 @@

    CommonDeploymentProfileDetailsResp<

    -

    CommonDeployments

    +

    CommonImageCatalog

    -

    Deployments request structure. Deprecated.

    +

    Image catalog request structure.

    @@ -5143,107 +5067,152 @@

    CommonDeployments

    + +
    -

    autoscaler
    +

    crn
    optional
    -

    Autoscaler specs.

    +

    The catalog CRN (either CRN or name is required).
    -

    CommonAutoscaler

    +

    string
    -

    horizontalPodAutoscaler
    +

    name
    optional
    -

    Horizontal pod autoscaler specs.

    +

    The catalog name (either CRN or name is required).
    -

    CommonHorizontalPodAutoScaler

    +

    string
    +
    +
    +

    CommonImageCatalogResp

    +
    +

    Image catalog response structure.

    +
    + +++++ + + + + + + + + + +
    NameDescriptionSchema
    -

    istio
    +

    crn
    optional
    -

    Istio specs.

    +

    The catalog CRN (either CRN or name is required).
    -

    CommonIstio

    +

    string
    -

    logging
    +

    name
    optional
    -

    Logging specs.

    +

    The catalog name (either CRN or name is required).
    -

    CommonLogging

    +

    string
    +
    +
    +

    CommonInstanceGroup

    +
    +

    Instance group structure.

    +
    + +++++ + + + + + + + + - -
    NameDescriptionSchema
    -

    metering
    +

    accelerator
    optional
    -

    Metering specs.

    +

    Used only for GCP clusters. This is used to set GPU type and count for the cluster.
    -

    CommonMetering

    +

    CommonAccelerator
    -

    monitoring
    +

    autoscaling
    optional
    -

    Monitoring specs.

    +

    Autoscaling specs.
    -

    CommonMonitoring

    +

    CommonAutoScaling
    -

    nvidia
    +

    enableCfsQuota
    optional
    -

    Nvidia specs.

    +

    Enables CPU CFS quota. Defaults to true if not specified.
    +Default : true
    -

    CommonNvidia

    +

    boolean
    -

    repository
    +

    instanceCount
    optional
    -

    Repository for images.

    +

    Instance count.
    -

    string

    +

    integer (int64)
    -

    telemetryKmsKeyArn
    +

    instanceImage
    optional
    -

    Telemetry KMS key ARN.

    +

    Instance image.

    string

    @@ -5251,177 +5220,179 @@

    CommonDeployments

    -

    yunikorn
    +

    instanceTier
    optional
    -

    Yunikorn specs.

    +

    Instance tier.
    -

    CommonYuniKorn

    +

    string
    -
    -
    -

    CommonDeploymentsResp

    -
    -

    Deployments response structure.

    -
    - ----- - - - - + + + - - + + + + +
    NameDescriptionSchema
    +

    instanceTypes
    +optional

    +
    +

    Instance types. General purpose: M4, M5, M5a, M5ad, and M5d. Compute optimized: C3, C4, C5, C5d, C5n, and cc2.8xlarge. Memory optimized: cr1.8xlarge, R3, R4, R5, R5a, R5ad, R5d, X1, X1e, and z1d. Storage optimized: D2, H1, hs1.8xlarge, I2, I3, and I3en. Accelerated computing: F1, G2, G3, P2, and P3.

    +
    +

    < string > array

    +
    -

    autoscaler
    +

    kubeReservedCpu
    optional
    -

    Autoscaler specs.

    +

    Reserved kubelet CPU in millicpu.
    -

    CommonAutoscalerResp

    +

    integer (int64)
    -

    horizontalPodAutoscaler
    +

    kubeReservedMemory
    optional
    -

    Horizontal pod autoscaler specs.

    +

    Reserved kubelet memory in MiB.
    -

    CommonHorizontalPodAutoScalerResp

    +

    integer (int64)
    -

    istio
    +

    kubeReservedStorage
    optional
    -

    Istio specs.

    +

    Reserved kubelet ephemeral storage in MiB.
    -

    CommonDeploymentProfileDetailsResp

    +

    integer (int64)
    -

    knox
    +

    labels
    optional
    -

    Knox specs.

    +

    Labels.
    -

    CommonDeploymentProfileDetailsResp

    +

    < string, string > map
    -

    logging
    +

    name
    +required

    +
    +

    Name.

    +
    +

    string

    +
    +

    rootVolume
    optional
    -

    Logging specs.

    +

    Root volume specs. Recommended 50.
    -

    CommonLoggingResp

    +

    CommonRootVolume
    -

    metering
    +

    singleZone
    optional
    -

    Metering specs.

    +

    Use single availability zone. Simple boolean for EKS. AKS is used in conjunction with UseAvailabilityZones.
    -

    CommonMeteringResp

    +

    boolean
    -

    monitoring
    +

    systemReservedCpu
    optional
    -

    Monitoring specs.

    +

    Reserved OS CPU in millicpu.
    -

    CommonMonitoringResp

    +

    integer (int64)
    -

    nvidia
    +

    systemReservedMemory
    optional
    -

    Nvidia specs.

    +

    Reserved OS memory in MiB.
    -

    CommonNvidiaResp

    +

    integer (int64)
    -

    repository
    +

    systemReservedStorage
    optional
    -

    Repository for images.

    +

    Reserved OS ephemeral storage in MiB.
    -

    string

    +

    integer (int64)
    -

    telemetryKmsKeyArn
    +

    taints
    optional
    -

    Telemetry KMS key ARN.

    +

    Taints.
    -

    string

    +

    < string, string > map
    -

    yunikorn
    +

    useAvailabilityZones
    optional
    -

    Yunikorn specs.

    +

    Used for Azure clusters only.
    -

    CommonYuniKornResp

    +

    boolean
    -

    CommonEvent

    +

    CommonInstanceStateCounts

    -

    Event response structure.

    +

    Instance state counts response structure.

    @@ -5439,1072 +5410,93 @@

    CommonEvent

    + +
    -

    details
    +

    creating
    optional
    -

    Details.

    +

    Number of instances in creating state.
    -

    string

    +

    integer (int64)
    -

    name
    +

    running
    optional
    -

    Event name.

    +

    Number of instances in running state.
    -

    string

    +

    integer (int64)
    -

    progress
    +

    terminating
    optional
    -

    Progress.

    +

    Number of instances in terminating state.
    -

    string

    +

    integer (int64)
    -

    resourceType
    +

    total
    optional
    -

    Resource type.

    +

    Total number of instances.
    -

    string

    +

    integer (int64)
    +
    +
    +

    CommonLoggingResp

    +
    +

    Logging response structure.

    +
    + +++++ + + + + + + + + - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    status
    +

    enabled
    optional
    -

    Status.

    -
    -

    string

    -
    -

    statusReason
    -optional

    -
    -

    Status reason.

    -
    -

    string

    -
    -

    timestamp
    -optional

    -
    -

    Timestamp.

    -
    -

    string

    -
    -
    -
    -

    CommonHelm

    -
    -

    Helm structure.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    version
    -optional

    -
    -

    Helm version to be upgraded to.

    -
    -

    string

    -
    -
    -
    -

    CommonHorizontalPodAutoScaler

    -
    -

    Horizontal pod autoscaler request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    enabled
    -optional

    -
    -

    Enable flag.

    -
    -

    boolean

    -
    -
    -
    -

    CommonHorizontalPodAutoScalerResp

    -
    -

    Horizontal pod autoscaler response structure.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    enabled
    -optional

    -
    -

    Enable flag.

    -
    -

    boolean

    -
    -
    -
    -

    CommonImageCatalog

    -
    -

    Image catalog request structure.

    -
    - ----- - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    crn
    -optional

    -
    -

    The catalog CRN (either CRN or name is required).

    -
    -

    string

    -
    -

    name
    -optional

    -
    -

    The catalog name (either CRN or name is required).

    -
    -

    string

    -
    -
    -
    -

    CommonImageCatalogResp

    -
    -

    Image catalog response structure.

    -
    - ----- - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    crn
    -optional

    -
    -

    The catalog CRN (either CRN or name is required).

    -
    -

    string

    -
    -

    name
    -optional

    -
    -

    The catalog name (either CRN or name is required).

    -
    -

    string

    -
    -
    -
    -

    CommonInstanceGroup

    -
    -

    Instance group structure.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    accelerator
    -optional

    -
    -

    Used only for GCP clusters. This is used to set GPU type and count for the cluster.

    -
    -

    CommonAccelerator

    -
    -

    autoscaling
    -optional

    -
    -

    Autoscaling specs.

    -
    -

    CommonAutoScaling

    -
    -

    enableCfsQuota
    -optional

    -
    -

    Enables CPU CFS quota. Defaults to true if not specified.
    -Default : true

    -
    -

    boolean

    -
    -

    instanceCount
    -optional

    -
    -

    Instance count.

    -
    -

    integer (int64)

    -
    -

    instanceImage
    -optional

    -
    -

    Instance image.

    -
    -

    string

    -
    -

    instanceTier
    -optional

    -
    -

    Instance tier.

    -
    -

    string

    -
    -

    instanceTypes
    -optional

    -
    -

    Instance types. General purpose: M4, M5, M5a, M5ad, and M5d. Compute optimized: C3, C4, C5, C5d, C5n, and cc2.8xlarge. Memory optimized: cr1.8xlarge, R3, R4, R5, R5a, R5ad, R5d, X1, X1e, and z1d. Storage optimized: D2, H1, hs1.8xlarge, I2, I3, and I3en. Accelerated computing: F1, G2, G3, P2, and P3.

    -
    -

    < string > array

    -
    -

    kubeReservedCpu
    -optional

    -
    -

    Reserved kubelet CPU in millicpu.

    -
    -

    integer (int64)

    -
    -

    kubeReservedMemory
    -optional

    -
    -

    Reserved kubelet memory in MiB.

    -
    -

    integer (int64)

    -
    -

    kubeReservedStorage
    -optional

    -
    -

    Reserved kubelet ephemeral storage in MiB.

    -
    -

    integer (int64)

    -
    -

    labels
    -optional

    -
    -

    Labels.

    -
    -

    < string, string > map

    -
    -

    name
    -required

    -
    -

    Name.

    -
    -

    string

    -
    -

    rootVolume
    -optional

    -
    -

    Root volume specs. Recommended 50.

    -
    -

    CommonRootVolume

    -
    -

    singleZone
    -optional

    -
    -

    Use single availability zone. Simple boolean for EKS. AKS is used in conjunction with UseAvailabilityZones.

    -
    -

    boolean

    -
    -

    systemReservedCpu
    -optional

    -
    -

    Reserved OS CPU in millicpu.

    -
    -

    integer (int64)

    -
    -

    systemReservedMemory
    -optional

    -
    -

    Reserved OS memory in MiB.

    -
    -

    integer (int64)

    -
    -

    systemReservedStorage
    -optional

    -
    -

    Reserved OS ephemeral storage in MiB.

    -
    -

    integer (int64)

    -
    -

    taints
    -optional

    -
    -

    Taints.

    -
    -

    < string, string > map

    -
    -

    useAvailabilityZones
    -optional

    -
    -

    Used for Azure clusters only.

    -
    -

    boolean

    -
    -
    -
    -

    CommonInstanceStateCounts

    -
    -

    Instance state counts response structure.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    creating
    -optional

    -
    -

    Number of instances in creating state.

    -
    -

    integer (int64)

    -
    -

    running
    -optional

    -
    -

    Number of instances in running state.

    -
    -

    integer (int64)

    -
    -

    terminating
    -optional

    -
    -

    Number of instances in terminating state.

    -
    -

    integer (int64)

    -
    -

    total
    -optional

    -
    -

    Total number of instances.

    -
    -

    integer (int64)

    -
    -
    -
    -

    CommonIstio

    -
    -

    Istio request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    deploymentProfile
    -optional

    -
    -

    Deployment profile to use. Currently supported are common, cml and cde (default common).

    -
    -

    string

    -
    -

    enabled
    -optional

    -
    -

    True to enable istio installation (default true).

    -
    -

    boolean

    -
    -
    -
    -

    CommonKubernetes

    -
    -

    Kubernetes specs. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    version
    -optional

    -
    -

    Kubernetes version (default 1.28).

    -
    -

    string

    -
    -
    -
    -

    CommonLogging

    -
    -

    Logging request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    enabled
    -optional

    -
    -

    True to enable logging installation (default false).

    -
    -

    boolean

    -
    -
    -
    -

    CommonLoggingResp

    -
    -

    Logging response structure.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    enabled
    -optional

    -
    -

    True to enable logging installation (default false).

    -
    -

    boolean

    -
    -
    -
    -

    CommonMetering

    -
    -

    Metering request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    enabled
    -optional

    -
    -

    Flag to enable metering installation.

    -
    -

    boolean

    -
    -

    services
    -optional

    -
    -

    Array of services.

    -
    -

    < CommonMeteringService > array

    -
    -
    -
    -

    CommonMeteringResp

    -
    -

    Metering response structure.

    -
    - ----- - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    enabled
    -optional

    -
    -

    Flag to indicate if Monitoring is enabled.

    -
    -

    boolean

    -
    -

    services
    -optional

    -
    -

    Array of services.

    -
    -

    < CommonMeteringServiceResp > array

    -
    -
    -
    -

    CommonMeteringService

    -
    -

    Metering service request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    clusterCrn
    -optional

    -
    -

    Cluster CRN.

    -
    -

    string

    -
    -

    serviceConfiguration
    -optional

    -
    -

    Service configuration.

    -
    -

    string

    -
    -

    serviceType
    -optional

    -
    -

    Service type.

    -
    -

    string

    -
    -

    serviceVersion
    -optional

    -
    -

    Service version.

    -
    -

    string

    -
    -

    workloadCrn
    -optional

    -
    -

    Workload CRN.

    -
    -

    string

    -
    -
    -
    -

    CommonMeteringServiceResp

    -
    -

    Metering service response structure.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    clusterCrn
    -optional

    -
    -

    Cluster CRN.

    -
    -

    string

    -
    -

    serviceConfiguration
    -optional

    -
    -

    Service configuration.

    -
    -

    string

    -
    -

    serviceType
    -optional

    -
    -

    Service type.

    -
    -

    string

    -
    -

    serviceVersion
    -optional

    -
    -

    Service version.

    -
    -

    string

    -
    -

    workloadCrn
    -optional

    -
    -

    Workload CRN.

    -
    -

    string

    -
    -
    -
    -

    CommonMonitoring

    -
    -

    Monitoring request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    alertmanager
    -optional

    -
    -

    Alertmanager.

    -
    -

    CommonAlertmanager

    -
    -

    enabled
    -optional

    -
    -

    Flag to enable Monitoring installation.

    +

    True to enable logging installation (default false).

    boolean
    -

    serverResourceLimit
    -optional

    -
    -

    Server resource limits.

    -
    -

    CommonResourceLimit

    -
    -

    CommonMonitoringResp

    +

    CommonMeteringResp

    -

    Monitoring response structure.

    +

    Metering response structure.

    @@ -6522,18 +5514,6 @@

    CommonMonitoringResp

    - - - - - @@ -6541,146 +5521,28 @@

    CommonMonitoringResp

    Flag to indicate if Monitoring is enabled.

    - - - - - - - -
    -

    alertmanager
    -optional

    -
    -

    Alertmanager.

    -
    -

    CommonAlertmanagerResp

    -

    enabled
    optional
    -

    boolean

    -
    -

    serverResourceLimits
    -optional

    -
    -

    Server resource limits.

    -
    -

    CommonResourceLimitsResp

    -
    -
    -
    -

    CommonNetwork

    -
    -

    Network structure.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    cidr
    -optional

    -
    -

    VPC CIDR. Deprecated.

    -
    -

    string

    -
    -

    inboundProxyCidrs
    -optional

    -
    -

    Allow these CIDR for inbound communication when using environment proxy settings. Only if backend supports it. Deprecated.

    -
    -

    < string > array

    -
    -

    outboundType
    -optional

    -
    -

    Cluster outbound type. Currently supported is udr.

    -
    -

    string

    -
    -

    plugin
    -optional

    -
    -

    Network plugin (default multus). Deprecated.

    -
    -

    string

    -
    -

    podCidr
    -optional

    -
    -

    The pod CIDR to use if the backend provider supports setting this.

    -
    -

    string

    -
    -

    serviceCidr
    -optional

    -
    -

    The CIDR for services declared inside of Kubernetes if the backend provider supports setting this.

    -
    -

    string

    -
    -

    subnets
    -optional

    -
    -

    Subnets.

    -
    -

    < string > array

    +

    boolean
    -

    topology
    +

    services
    optional
    -

    Network topology. Deprecated.

    +

    Array of services.
    -

    CommonNetworkTopology

    +

    < CommonMeteringServiceResp > array
    -

    CommonNetworkTopology

    +

    CommonMeteringServiceResp

    -

    Network topology structure. Deprecated.

    +

    Metering service response structure.

    @@ -6698,45 +5560,35 @@

    CommonNetworkTopology

    - -
    -

    subnets
    +

    clusterCrn
    optional
    -

    Subnets.

    +

    Cluster CRN.
    -

    < string > array

    +

    string
    -
    -
    -

    CommonNodeImageAvailableUpgrade

    -
    -

    Structure to list the currently used images and the new upgrades available.

    -
    - ----- - - - - + + + - -
    NameDescriptionSchema
    +

    serviceConfiguration
    +optional

    +
    +

    Service configuration.

    +
    +

    string

    +
    -

    current
    +

    serviceType
    optional
    -

    Currently used node image version.

    +

    Service type.

    string

    @@ -6744,11 +5596,11 @@

    CommonNodeImageAvailableUpgrade

    -

    instanceGroup
    +

    serviceVersion
    optional
    -

    Instance group name.

    +

    Service version.

    string

    @@ -6756,23 +5608,23 @@

    CommonNodeImageAvailableUpgrade

    -

    upgrades
    +

    workloadCrn
    optional
    -

    Available node image upgrade versions.

    +

    Workload CRN.
    -

    < string > array

    +

    string
    -

    CommonNvidia

    +

    CommonMonitoringResp

    -

    Nvidia request structure. Deprecated.

    +

    Monitoring response structure.

    @@ -6790,35 +5642,56 @@

    CommonNvidia

    + + + + +
    -

    gpuLabelKey
    +

    alertmanager
    optional
    -

    GPU label key.

    +

    Alertmanager.
    -

    string

    +

    CommonAlertmanagerResp
    -

    gpuLabelValue
    +

    enabled
    optional
    -

    GPU label value.

    +

    Flag to indicate if Monitoring is enabled.
    -

    string

    +

    boolean

    +
    +

    serverResourceLimits
    +optional

    +
    +

    Server resource limits.

    +
    +

    CommonResourceLimitsResp
    -

    CommonNvidiaResp

    +

    CommonNetwork

    -

    Nvidia response structure.

    +

    Network structure.

    +
    +
    +

    Type : object

    +
    +
    +
    +

    CommonNodeImageAvailableUpgrade

    +
    +

    Structure to list the currently used images and the new upgrades available.

    @@ -6836,11 +5709,11 @@

    CommonNvidiaResp

    + + + + +
    -

    gpuLabelKey
    +

    current
    optional
    -

    GPU label key.

    +

    Currently used node image version.

    string

    @@ -6848,23 +5721,35 @@

    CommonNvidiaResp

    -

    gpuLabelValue
    +

    instanceGroup
    optional
    -

    GPU label value.

    +

    Instance group name.

    string
    +

    upgrades
    +optional

    +
    +

    Available node image upgrade versions.

    +
    +

    < string > array

    +
    -

    CommonResourceLimit

    +

    CommonNvidiaResp

    -

    Resource limits request structure. Deprecated.

    +

    Nvidia response structure.

    @@ -6882,11 +5767,11 @@

    CommonResourceLimit

    -

    cpu
    +

    gpuLabelKey
    optional
    -

    Prometheus server CPU limit (default 1000m).

    +

    GPU label key.

    string

    @@ -6894,11 +5779,11 @@

    CommonResourceLimit

    -

    memory
    +

    gpuLabelValue
    optional
    -

    Prometheus server memory limit (default 2048M).

    +

    GPU label value.

    string

    @@ -7564,76 +6449,6 @@

    CommonVolumeEncryptionResp

    -

    CommonYuniKorn

    -
    -

    YuniKorn request structure. Deprecated.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    appSortingPolicy
    -optional

    -
    -

    The app sorting policy is ignored for overrides will be removed soon.

    -
    -

    string

    -
    -

    enabled
    -optional

    -
    -

    Flag to enable yunikorn (default true).

    -
    -

    boolean

    -
    -

    nodeSortingPolicy
    -optional

    -
    -

    The node sorting policy is ignored for overrides will be removed soon.

    -
    -

    string

    -
    -

    version
    -optional

    -
    -

    Version is ignored for overrides will be removed soon.

    -
    -

    string

    -
    -
    -

    CommonYuniKornResp

    YuniKorn response structure.

    @@ -7851,7 +6666,7 @@

    CreateClusterRequest

    environment
    -optional

    +required

    Environment CRN. Required.

    @@ -7862,20 +6677,8 @@

    CreateClusterRequest

    -

    metadata
    -optional

    -
    -
    -

    Specifies the metadata. Deprecated.

    -
    -
    -

    CommonClusterMetadata

    -
    - - -

    name
    -optional

    +required

    Cluster name. Required.

    @@ -7910,18 +6713,6 @@

    CreateClusterRequest

    -

    spec
    -optional

    -
    -
    -

    Specifies the spec. Deprecated.

    -
    -
    -

    CommonClusterSpec

    -
    - - -

    tags
    optional

    @@ -9848,18 +8639,6 @@

    EksState

    -

    laceworkEnabled
    -optional

    -
    -
    -

    Whether lacework is enabled.

    -
    -
    -

    boolean

    -
    - - -

    networkPlugin
    optional

    @@ -9956,18 +8735,6 @@

    EksState

    -

    stopDeleteOnError
    -optional

    -
    -
    -

    Whether to stop deletion on error.

    -
    -
    -

    boolean

    -
    - - -

    subnets
    optional

    @@ -12148,7 +10915,7 @@

    ValidateClusterRequest

    environment
    -optional

    +required

    Environment CRN. Required.

    @@ -12159,20 +10926,8 @@

    ValidateClusterRequest

    -

    metadata
    -optional

    -
    -
    -

    Specifies the metadata. Deprecated.

    -
    -
    -

    CommonClusterMetadata

    -
    - - -

    name
    -optional

    +required

    Cluster name. Required.

    @@ -12195,18 +10950,6 @@

    ValidateClusterRequest

    -

    spec
    -optional

    -
    -
    -

    Specifies the spec. Deprecated.

    -
    -
    -

    CommonClusterSpec

    -
    - - -

    tags
    optional

    @@ -12553,7 +11296,7 @@

    ValidationSummary


    diff --git a/api-docs-beta/consumption/index.html b/api-docs-beta/consumption/index.html index 182854b21..0a7116413 100644 --- a/api-docs-beta/consumption/index.html +++ b/api-docs-beta/consumption/index.html @@ -720,7 +720,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -1259,7 +1259,7 @@

    ListComputeUsageRecordsResponse


    diff --git a/api-docs-beta/datacatalog/index.html b/api-docs-beta/datacatalog/index.html index 43747b4d3..84d60008b 100644 --- a/api-docs-beta/datacatalog/index.html +++ b/api-docs-beta/datacatalog/index.html @@ -721,7 +721,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -1220,7 +1220,7 @@

    LaunchProfilersResponse


    diff --git a/api-docs-beta/datahub/index.html b/api-docs-beta/datahub/index.html index fbf7e2ed5..542b63366 100644 --- a/api-docs-beta/datahub/index.html +++ b/api-docs-beta/datahub/index.html @@ -1406,7 +1406,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -19259,7 +19259,7 @@

    VolumeEncryptionRequest


    diff --git a/api-docs-beta/datalake/index.html b/api-docs-beta/datalake/index.html index 9ceff6d58..7cd88de88 100644 --- a/api-docs-beta/datalake/index.html +++ b/api-docs-beta/datalake/index.html @@ -1240,7 +1240,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -14925,7 +14925,7 @@

    ValidateAzureCloudStorageResponse
    diff --git a/api-docs-beta/de/index.html b/api-docs-beta/de/index.html index af847f067..4b360b1e8 100644 --- a/api-docs-beta/de/index.html +++ b/api-docs-beta/de/index.html @@ -781,48 +781,62 @@

    Cloudera Data Engineering

  • Responses
    • -
  • List Cloudera Data Engineering(CDE) Service Backups +
  • Get CDE Service Upgrade Status.
    • -
  • List Cloudera Data Engineering(CDE) Services +
  • List Cloudera Data Engineering(CDE) Service Backups
    • -
  • List Virtual Clusters +
  • List Cloudera Data Engineering(CDE) Services
    • -
  • Restore Cloudera Data Engineering(CDE) Service +
  • List Virtual Clusters
    • -
  • Update Cloudera Data Engineering (CDE) Service +
  • Restore Cloudera Data Engineering(CDE) Service
    • -
  • Update Cloudera Data Engineering (CDE) Virtual Cluster +
  • Update Cloudera Data Engineering (CDE) Service
    • +
  • Update Cloudera Data Engineering (CDE) Virtual Cluster + +
    • +
  • Trigger a particular step (prepare, backup, upgrade, resume) of the upgrade framework. + +
  • Definitions @@ -861,6 +875,8 @@

    Cloudera Data Engineering

  • GetKubeconfigResponse
  • GetServiceInitLogsRequest
  • GetServiceInitLogsResponse
    • +
  • GetUpgradeStatusRequest
    • +
  • GetUpgradeStatusResponse
  • ListBackupsRequest
  • ListBackupsResponse
  • ListServicesRequest
    • @@ -879,6 +895,8 @@

    Cloudera Data Engineering

  • UpdateServiceResponse
  • UpdateVcRequest
  • UpdateVcResponse
    • +
  • UpgradeServiceRequest
    • +
  • UpgradeServiceResponse
  • VcDescription
  • VcResources
  • VcSummary
    • @@ -897,7 +915,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -2057,6 +2075,92 @@

    Responses

    +

    Get CDE Service Upgrade Status.

    +
    +
    +
    POST /api/v1/de/getUpgradeStatus
    +
    +
    +
    +

    Description

    +
    +

    The current status of the CDE Service upgrade. If all the steps are completed allStepsCompleted would be true. After a particular step triggered by upgrade-service is completed nextStep would point to the next step to take.

    +
    +
    +
    +

    Parameters

    + +++++ + + + + + + + + + + + + + + +
    TypeNameSchema
    +

    Body

    +
    +

    input
    +required

    +
    +

    GetUpgradeStatusRequest

    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema
    +

    200

    +
    +

    Expected response to a valid request.

    +
    +

    GetUpgradeStatusResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    +

    List Cloudera Data Engineering(CDE) Service Backups

    @@ -2064,13 +2168,13 @@

    List Cloudera Data Engineering(CDE) Service Backups

    -

    Description

    +

    Description

    List all service backups.

    -

    Parameters

    +

    Parameters

    @@ -2101,7 +2205,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2150,13 +2254,13 @@

    List Cloudera Data Engineering(CDE) Services

    -

    Description

    +

    Description

    Returns list of cde services.

    -

    Parameters

    +

    Parameters

    @@ -2187,7 +2291,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2236,13 +2340,13 @@

    List Virtual Clusters

    -

    Description

    +

    Description

    Returns a list of virtual clusters for a given CDE service.

    -

    Parameters

    +

    Parameters

    @@ -2273,7 +2377,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2322,13 +2426,13 @@

    Restore Cloudera Data Engineering(CDE) Service

    -

    Description

    +

    Description

    Initiates the service restoration process and returns the ID of the service being restored.

    -

    Parameters

    +

    Parameters

    @@ -2359,7 +2463,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2408,13 +2512,13 @@

    Update Cloudera Data Engineering (CDE) Service

    -

    Description

    +

    Description

    Returns update response consisting of operation ID that can be used to log update events.

    -

    Parameters

    +

    Parameters

    @@ -2445,7 +2549,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2494,13 +2598,13 @@

    Update Cloudera Data Engineering (CDE) Virtual Cluster

    -

    Description

    +

    Description

    Updates Cloudera Data Engineering (CDE) Virtual Cluster and returns details of updated CDE service.

    -

    Parameters

    +

    Parameters

    @@ -2531,7 +2635,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -2572,6 +2676,92 @@

    Responses

    +
    +

    Trigger a particular step (prepare, backup, upgrade, resume) of the upgrade framework.

    +
    +
    +
    POST /api/v1/de/upgradeService
    +
    +
    +
    +

    Description

    +
    +

    Trigger a particular step (prepare, backup, upgrade, resume) of the multi-step upgrade process. Use get-upgrade-status to know what is the next step to take.

    +
    +
    +
    +

    Parameters

    + +++++ + + + + + + + + + + + + + + +
    TypeNameSchema
    +

    Body

    +
    +

    input
    +required

    +
    +

    UpgradeServiceRequest

    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema
    +

    200

    +
    +

    Expected response to a valid request.

    +
    +

    UpgradeServiceResponse

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +
    @@ -3619,6 +3809,18 @@

    CreateVcRequest

    +

    sparkConfigs
    +optional

    +
    +
    +

    Spark configs that will be applied to all the spark jobs inside a virtual cluster.

    +
    +
    +

    < string, string > map

    +
    + + +

    sparkVersion
    optional

    @@ -4297,6 +4499,30 @@

    EnableServiceRequest

    +

    azureDatabasePrivateDNSZoneId
    +optional

    +
    +
    +

    Resource ID of the custom private DNS zone associated with the Azure database.

    +
    +
    +

    string

    +
    + + +
    +

    azureFilesharePrivateDNSZoneId
    +optional

    +
    +
    +

    Resource ID of custom private DNS zone for Azure storage account.

    +
    +
    +

    string

    +
    + + +

    chartValueOverrides
    optional

    @@ -4999,6 +5225,98 @@

    GetServiceInitLogsResponse

    +

    GetUpgradeStatusRequest

    +
    +

    Request object for GetUpgradeStatus method.

    +
    + +++++ + + + + + + + + + + + + + + +
    NameDescriptionSchema
    +

    clusterId
    +required

    +
    +

    Cluster ID of the service.

    +
    +

    string

    +
    +
    +
    +

    GetUpgradeStatusResponse

    +
    +

    Response object for GetUpgradeStatus request.

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionSchema
    +

    allStepsCompleted
    +optional

    +
    +

    Whether all the steps of the multi-step upgrade process completed.

    +
    +

    boolean

    +
    +

    nextStep
    +optional

    +
    +

    The next step to take in multi-step upgrade process. Currently supported steps are prepare, backup, upgrade and resume.

    +
    +

    enum (prepare, backup, upgrade, resume)

    +
    +

    upgradeStatusMessage
    +optional

    +
    +

    The status of the upgrade.

    +
    +

    string

    +
    +
    +

    ListBackupsRequest

    Request object for List Backups command.

    @@ -6472,6 +6790,19 @@

    UpdateVcRequest

    +

    discardSparkConfigs
    +optional

    +
    +
    +

    Discard the Spark configs inside a VC.
    +Default : false

    +
    +
    +

    boolean

    +
    + + +

    fullAccessGroups
    optional

    @@ -6496,6 +6827,18 @@

    UpdateVcRequest

    +

    sparkConfigs
    +optional

    +
    +
    +

    Spark configs that will be applied to all the spark jobs inside a virtual cluster.

    +
    +
    +

    < string, string > map

    +
    + + +

    vcId
    required

    @@ -6568,6 +6911,87 @@

    UpdateVcResponse

    +

    UpgradeServiceRequest

    +
    +

    Request object for upgrading a service.

    +
    + +++++ + + + + + + + + + + + + + + + + + + + +
    NameDescriptionSchema
    +

    clusterId
    +required

    +
    +

    Cluster ID of the service to upgrade.

    +
    +

    string

    +
    +

    step
    +required

    +
    +

    The maintenance step to be performed. Currently supported steps are prepare, backup, upgrade, cancel and resume.

    +
    +

    enum (prepare, backup, upgrade, cancel, resume)

    +
    +
    +
    +

    UpgradeServiceResponse

    +
    +

    Response object for UpgradeService request.

    +
    + +++++ + + + + + + + + + + + + + + +
    NameDescriptionSchema
    +

    message
    +optional

    +
    +

    The status message of upgrade operation.
    +Default : "upgrade step triggered successfully"

    +
    +

    string

    +
    +
    +

    VcDescription

    CDE virtual cluster summary.

    @@ -6756,6 +7180,18 @@

    VcDescription

    +

    sparkConfigs
    +optional

    +
    +
    +

    Spark configs that will be applied to all the spark jobs inside a virtual cluster.

    +
    +
    +

    < string, string > map

    +
    + + +

    sparkVersion
    optional

    @@ -7058,7 +7494,7 @@

    VcSummary


    diff --git a/api-docs-beta/df/index.html b/api-docs-beta/df/index.html index 501757b45..a297d6c80 100644 --- a/api-docs-beta/df/index.html +++ b/api-docs-beta/df/index.html @@ -1212,7 +1212,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -14419,7 +14419,7 @@

    UpgradeServiceResponse


    diff --git a/api-docs-beta/dfworkload/index.html b/api-docs-beta/dfworkload/index.html index d8ab84a9b..2d57b1fea 100644 --- a/api-docs-beta/dfworkload/index.html +++ b/api-docs-beta/dfworkload/index.html @@ -1214,7 +1214,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -14359,7 +14359,7 @@

    ValidateCustomPythonConfigur


    diff --git a/api-docs-beta/drscp/index.html b/api-docs-beta/drscp/index.html index ed6a9a523..3c661c48d 100644 --- a/api-docs-beta/drscp/index.html +++ b/api-docs-beta/drscp/index.html @@ -797,7 +797,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -2842,7 +2842,7 @@

    SimpleRestore


    diff --git a/api-docs-beta/dw/index.html b/api-docs-beta/dw/index.html index c1535a185..bcd2a449c 100644 --- a/api-docs-beta/dw/index.html +++ b/api-docs-beta/dw/index.html @@ -1313,34 +1313,27 @@

    Cloudera Data Warehouse [EXPERIMENTAL]

  • Responses
    • -
  • Upgrade the Cloudera Data Warehouse cluster. +
  • Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.
    • -
  • Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization. +
  • Upgrades the Database Catalog to a compatible version.
    • -
  • Upgrades the Database Catalog to a compatible version. +
  • Upgrades the Virtual Warehouse to a compatible version.
    • -
  • Upgrades the Virtual Warehouse to a compatible version. - -
  • Definitions @@ -1607,8 +1600,6 @@

    Cloudera Data Warehouse [EXPERIMENTAL]

  • UpdateVwConfigResponse
  • UpdateVwRequest
  • UpdateVwResponse
    • -
  • UpgradeClusterRequest
    • -
  • UpgradeClusterResponse
  • UpgradeDataVisualizationRequest
  • UpgradeDataVisualizationResponse
  • UpgradeDbcRequest
    • @@ -1636,7 +1627,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -9343,92 +9334,6 @@

    Responses

    -

    Upgrade the Cloudera Data Warehouse cluster.

    -
    -
    -
    POST /api/v1/dw/upgradeCluster
    -
    -
    -
    -

    Description

    -
    -

    Upgrade the Cloudera Data Warehouse cluster to the latest supported version. Expect downtime during the upgrade and refrain issuing queries. You can check the current status of the cluster with the describe-cluster command.

    -
    -
    -
    -

    Parameters

    - ----- - - - - - - - - - - - - - - -
    TypeNameSchema
    -

    Body

    -
    -

    input
    -required

    -
    -

    UpgradeClusterRequest

    -
    -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema
    -

    200

    -
    -

    Expected response to a valid request.

    -
    -

    UpgradeClusterResponse

    -
    -

    default

    -
    -

    The default response on an error.

    -
    -

    Error

    -
    -
    -
    -

    Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.

    @@ -9436,13 +9341,13 @@

    Asynchronous operation that upgrades a Cloude

    -

    Description

    +

    Description

    Asynchronous operation that upgrades a Cloudera Data Visualization to a compatible version. The describe-data-visualization can be used at any time to get the latest status of a Data Visualization.

    -

    Parameters

    +

    Parameters

    @@ -9473,7 +9378,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9522,13 +9427,13 @@

    Upgrades the Database Catalog to a compatible version.

    -

    Description

    +

    Description

    Upgrades the Database Catalog to a compatible version.

    -

    Parameters

    +

    Parameters

    @@ -9559,7 +9464,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -9608,13 +9513,13 @@

    Upgrades the Virtual Warehouse to a compatible version.

    -

    Description

    +

    Description

    Upgrades the Virtual Warehouse to a compatible version.

    -

    Parameters

    +

    Parameters

    @@ -9645,7 +9550,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -10878,8 +10783,17 @@

    AwsActivationOptions

    computeInstanceTypes
    optional

    - - - - - - - - - - - - - - - @@ -15452,7 +15378,7 @@

    CustomRegistryOptions

    Custom registry type.

    @@ -15467,18 +15393,6 @@

    CustomRegistryOptions

    string

    - - - - -
    -

    DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.

    +
    + + + + + +
    +
    Note
    +    		 +The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values. +

    < string > array

    @@ -11116,8 +11030,17 @@

    AzureActivationOptions

    computeInstanceTypes
    optional

    -

    DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.

    +
    + + + + + +
    +
    Note
    +    		 +The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided. +

    < string > array

    @@ -11962,8 +11885,17 @@

    ClusterSummaryResponse

    computeInstanceTypes
    optional

    -

    DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. Compute instance types that the environment is restricted to use. This affects the creation of the virtual warehouses where this restriction will apply.

    +
    + + + + + +
    +
    Note
    +    		 +The cluster level instance type selection will be replaced by virtual warehouse level selection. Compute instance types that the environment is restricted to use. This affects the creation of the virtual warehouses where this restriction will apply. +

    < string > array

    @@ -12946,8 +12878,17 @@

    CreateAwsClusterRequest

    computeInstanceTypes
    optional

    -

    DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.

    +
    + + + + + +
    +
    Note
    +    		 +The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values. +

    < string > array

    @@ -13257,8 +13198,17 @@

    CreateAzureClusterRequest

    computeInstanceTypes
    optional

    -

    DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.

    +
    + + + + + +
    +
    Note
    +    		 +The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided. +

    < string > array

    @@ -15421,30 +15371,6 @@

    CustomRegistryOptions
    -

    disableImageVerification
    -optional

    -
    -

    Disable image verification.

    -
    -

    boolean

    -
    -

    password
    -optional

    -
    -

    Password for custom registry access (required only for Docker type).

    -
    -

    string

    -

    registryType
    optional
    -

    enum (ACR, ECR, Docker)

    +

    enum (ACR, ECR)
    -

    userName
    -optional

    -
    -

    Username for custom registry access (required only for Docker type).

    -
    -

    string

    -
    @@ -25105,110 +25019,6 @@

    UpdateVwResponse

    -

    UpgradeClusterRequest

    -
    -

    Request object for the upgradeCluster method.

    -
    - ----- - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    clusterId
    -required

    -
    -

    The ID of the cluster to upgrade.

    -
    -

    string

    -
    -
    -
    -

    UpgradeClusterResponse

    -
    -

    Response object for the upgradeCluster method.

    -
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionSchema
    -

    message
    -optional

    -
    -

    Detailed explanation of the status.

    -
    -

    string

    -
    -

    serviceUnhealthy
    -optional

    -
    -

    True, if the service is in unhealthy state, false or omitted otherwise.

    -
    -

    boolean

    -
    -

    status
    -optional

    -
    -

    The upgrade status. Possible values are: Upgrading, Error, Failed.

    -
    -

    string

    -
    -

    timedOut
    -optional

    -
    -

    True if the upgrade timed out, false or omitted otherwise.

    -
    -

    boolean

    -
    -
    -

    UpgradeDataVisualizationRequest

    Request object for the upgradeDataVisualization method.

    @@ -26565,7 +26375,7 @@

    VwType


    diff --git a/api-docs-beta/environments/index.html b/api-docs-beta/environments/index.html index 6306e4cd8..9d3c40bae 100644 --- a/api-docs-beta/environments/index.html +++ b/api-docs-beta/environments/index.html @@ -1649,7 +1649,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -24841,7 +24841,7 @@

    ValidateAzureCloudStorageResponse
    diff --git a/api-docs-beta/iam/index.html b/api-docs-beta/iam/index.html index 786f0fd10..ab60e5993 100644 --- a/api-docs-beta/iam/index.html +++ b/api-docs-beta/iam/index.html @@ -1435,7 +1435,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -15812,7 +15812,7 @@

    WorkloadPasswordPolicy


    diff --git a/api-docs-beta/imagecatalog/index.html b/api-docs-beta/imagecatalog/index.html index 33407e117..1910e9fc7 100644 --- a/api-docs-beta/imagecatalog/index.html +++ b/api-docs-beta/imagecatalog/index.html @@ -853,7 +853,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -3915,7 +3915,7 @@

    VmImageType


    diff --git a/api-docs-beta/metrics/index.html b/api-docs-beta/metrics/index.html index fee851891..18ed53318 100644 --- a/api-docs-beta/metrics/index.html +++ b/api-docs-beta/metrics/index.html @@ -775,7 +775,7 @@

    Overview

    Version information

    -

    Version : 0.9.120 (BETA)

    +

    Version : 0.9.121 (BETA)

    @@ -2755,7 +2755,7 @@

    UpdateRemoteWriteConfigResponse


    diff --git a/api-docs-beta/ml/index.html b/api-docs-beta/ml/index.html index d4e579bd1..5221b26c0 100644 --- a/api-docs-beta/ml/index.html +++ b/api-docs-beta/ml/index.html @@ -690,7 +690,7 @@

    Cloudera Machine Learning

  • Paths
      -
    • Add new Cloudera Machine Learning Serving App’s cluster instance groups. +
    • Add instance group to an existing Cloudera AI Inference Service instance.
      • -
    • Create a Cloudera Machine Learning Serving App. +
    • Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.
      • -
    • Deletes an instance group from the cluster. +
    • Deletes an instance group from a Cloudera AI Inference Service instance.
      • -
    • Deletes Cloudera Machine Learning Serving App. +
    • Deletes Cloudera AI Inference Service instance.
      • -
    • Describe Cloudera Machine Learning Serving App. +
    • Describe Cloudera AI Inference Service instance.
      • -
    • Return kubeconfig for Ml Serving App. +
    • Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster.
      • -
    • Grant access to Cloudera Machine Learning Model Serving App. +
    • Grants admin access to a Cloudera AI Inference Service cluster.
      • -
    • List member access for Cloudera Machine Learning Model Serving App. +
    • List members that have Kubernetes access to a Cloudera AI Inference Service cluster.
      • -
    • List all Cloudera Machine Learning Serving Apps. +
    • List all Cloudera AI Inference Service instances.
      • -
    • Modify a Cloudera Machine Learning Serving App’s cluster instance group. +
    • Modify instance groups for a Cloudera AI Inference Service cluster.
      • -
    • Revoke access to Cloudera Machine Learning Model Serving App. +
    • Revokes access to a Cloudera AI Inference Service cluster.
      • -
    • Upgrade a Cloudera Machine Learning Serving App. +
    • Upgrade a Cloudera AI Inference Service instance.
      • Description
      • Parameters
        • @@ -1173,7 +1173,7 @@

        Overview

        Version information

        -

        Version : 0.9.120 (BETA)

        +

        Version : 0.9.121 (BETA)

        @@ -1215,7 +1215,7 @@

        Produces

        Paths

        -

        Add new Cloudera Machine Learning Serving App’s cluster instance groups.

        +

        Add instance group to an existing Cloudera AI Inference Service instance.

        POST /api/v1/ml/addInstanceGroupsMlServingApp
        @@ -1224,7 +1224,7 @@

        Add new Cloudera Machine Learning Servin

        Description

        -

        Add new Cloudera Machine Learning Serving App’s cluster instance groups.

        +

        Add instance group to an existing Cloudera AI Inference Service instance.

        @@ -1387,7 +1387,7 @@

        Responses

        -

        Create a Cloudera Machine Learning Serving App.

        +

        Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.

        POST /api/v1/ml/createMlServingApp
        @@ -1396,7 +1396,7 @@

        Create a Cloudera Machine Learning Serving App.

        Description

        -

        Provision a Kubernetes cluster and install the Cloudera Machine Learning application in it.

        +

        Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.

        @@ -1817,7 +1817,7 @@

        Responses

        -

        Deletes an instance group from the cluster.

        +

        Deletes an instance group from a Cloudera AI Inference Service instance.

        POST /api/v1/ml/deleteInstanceGroupMlServingApp
        @@ -1826,7 +1826,7 @@

        Deletes an instance group from the clu

        Description

        -

        Deletes an instance group from a Cloudera Machine Serving App’s cluster.

        +

        Deletes an instance group from a Cloudera AI Inference Service instance.

        @@ -1903,7 +1903,7 @@

        Responses

        -

        Deletes Cloudera Machine Learning Serving App.

        +

        Deletes Cloudera AI Inference Service instance.

        POST /api/v1/ml/deleteMlServingApp
        @@ -1912,7 +1912,7 @@

        Deletes Cloudera Machine Learning Serving App.

        Description

        -

        Gracefully deletes the CML Serve App.

        +

        Gracefully deletes the Cloudera AI Inference Service instance without deleting the cluster.

        @@ -2161,7 +2161,7 @@

        Responses

        -

        Describe Cloudera Machine Learning Serving App.

        +

        Describe Cloudera AI Inference Service instance.

        POST /api/v1/ml/describeMlServingApp
        @@ -2170,7 +2170,7 @@

        Describe Cloudera Machine Learning Serving App.

        Description

        -

        Describe Cloudera Machine Learning Serving App.

        +

        Describe Cloudera AI Inference Service instance.

        @@ -2763,7 +2763,7 @@

        Responses

        -

        Return kubeconfig for Ml Serving App.

        +

        Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster.

        POST /api/v1/ml/getMlServingAppKubeconfig
        @@ -2772,7 +2772,7 @@

        Return kubeconfig for Ml Serving App.

        Description

        -

        Gets the Kubeconfig of the Ml Serving cluster.

        +

        Gets the Kubeconfig of the Cloudera AI Inference Service kubernetes cluster.

        @@ -2935,7 +2935,7 @@

        Responses

        -

        Grant access to Cloudera Machine Learning Model Serving App.

        +

        Grants admin access to a Cloudera AI Inference Service cluster.

        POST /api/v1/ml/grantMlServingAppAccess
        @@ -2944,7 +2944,7 @@

        Grant access to Cloudera Machine Learning Mode

        Description

        -

        Grants an AWS user to perform Kubernetes operations on a Cloudera Machine Learning Model Serving App.

        +

        Grants an AWS user permissions to perform Kubernetes operations on a Cloudera AI Inference Service cluster.

        @@ -3279,7 +3279,7 @@

        Responses

        -

        List member access for Cloudera Machine Learning Model Serving App.

        +

        List members that have Kubernetes access to a Cloudera AI Inference Service cluster.

        POST /api/v1/ml/listMlServingAppAccess
        @@ -3288,7 +3288,7 @@

        List member access for Cloudera Machine Learnin

        Description

        -

        Lists users that can perform Kubernetes operations on a Cloudera Machine Learning Model Serving App

        +

        Lists users that can perform Kubernetes operations on a Cloudera AI Inference Service cluster.

        @@ -3365,7 +3365,7 @@

        Responses

        -

        List all Cloudera Machine Learning Serving Apps.

        +

        List all Cloudera AI Inference Service instances.

        POST /api/v1/ml/listMlServingApps
        @@ -3374,7 +3374,7 @@

        List all Cloudera Machine Learning Serving Apps.

        Description

        -

        List all Cloudera Machine Learning Serving Apps.

        +

        List all Cloudera AI Inference Service instances.

        @@ -4139,7 +4139,7 @@

        Responses

        -

        Modify a Cloudera Machine Learning Serving App’s cluster instance group.

        +

        Modify instance groups for a Cloudera AI Inference Service cluster.

        POST /api/v1/ml/modifyMlServingApp
        @@ -4148,7 +4148,7 @@

        Modify a Cloudera Machine Learning Serving App̵

        Description

        -

        Modify a Cloudera Machine Learning Serving App’s cluster instance group.

        +

        Modify instance groups for a Cloudera AI Inference Service cluster.

        @@ -4655,7 +4655,7 @@

        Responses

        -

        Revoke access to Cloudera Machine Learning Model Serving App.

        +

        Revokes access to a Cloudera AI Inference Service cluster.

        POST /api/v1/ml/revokeMlServingAppAccess
        @@ -4664,7 +4664,7 @@

        Revoke access to Cloudera Machine Learning Mo

        Description

        -

        Revokes an AWS user to perform Kubernetes operations on a Cloudera Machine Learning Model Serving App.

        +

        Revokes an AWS user permissions on a Cloudera AI Inference Service cluster.

        @@ -5085,7 +5085,7 @@

        Responses

        -

        Upgrade a Cloudera Machine Learning Serving App.

        +

        Upgrade a Cloudera AI Inference Service instance.

        POST /api/v1/ml/upgradeMlServingApp
        @@ -5094,7 +5094,7 @@

        Upgrade a Cloudera Machine Learning Serving App.

        Description

        -

        Upgrades a Cloudera Machine Learning Serving App to the latest available version.

        +

        Upgrade a Cloudera AI Inference Service instance to the latest available version.

        @@ -5350,7 +5350,7 @@

        Definitions

        AddInstanceGroupsMlServingAppRequest

        -

        Request object for AddInstanceGroupsMlServing method.

        +

        Request object for AddInstanceGroupsMlServingApp method.

        @@ -5372,7 +5372,7 @@

        AddInstanceGroupsMlServingAppRequ required

        - - - - - - - - - - @@ -6105,7 +6081,7 @@

        CreateMlServingAppRequest

        optional

        -

        The CRN of the MLServing App to which the instance groups are to be added.

        +

        The CRN of the Cloudera AI Inference Service instance to which the instance groups will be added.

        string

        @@ -5384,7 +5384,7 @@

        AddInstanceGroupsMlServingAppRequ required
        -

        The instance groups that we want to add to the MLServing App.

        +

        The instance groups to be added to the Cloudera AI Inference Service instance.

        < InstanceGroup > array

        @@ -5396,7 +5396,7 @@

        AddInstanceGroupsMlServingAppRequ

        AddInstanceGroupsMlServingAppResponse

        -

        Response object for AddInstanceGroupsMlServing.

        +

        Response object for AddInstanceGroupsMlServingApp method.

        Type : object

        @@ -6009,7 +6009,7 @@

        CreateMlServingAppRequest

        required
        -

        The name of the App to create.

        +

        The name of the Cloudera AI Inference Service to be created.

        string

        @@ -6021,7 +6021,7 @@

        CreateMlServingAppRequest

        required
        -

        The cluster CRN of an existing cluster that the AI inference App will use.

        +

        The cluster CRN of an existing cluster where Cloudera AI Inference Service instance will be deployed.

        string

        @@ -6029,23 +6029,11 @@

        CreateMlServingAppRequest

        -

        disableTLS
        -optional

        -
        -

        The boolean flag to disable TLS setup for MlServingApp. By default, the TLS is enabled.

        -
        -

        boolean

        -

        environmentCrn
        required
        -

        The environment CRN for the App.

        +

        The environment CRN.

        string

        @@ -6065,18 +6053,6 @@

        CreateMlServingAppRequest

        -

        mlservingVersion
        -required

        -
        -

        The version of ML workload app to install.

        -
        -

        string

        -

        provisionK8sRequest
        optional
        -

        The static subdomain to be used for the serving app.

        +

        The static subdomain to be used for the Cloudera AI Inference Service instance.

        string

        @@ -6117,7 +6093,7 @@

        CreateMlServingAppRequest

        optional
        -

        The list of subnets used for the load balancer that CML creates.

        +

        The list of subnets to be used for the load balancer.

        < string > array

        @@ -6163,7 +6139,7 @@

        CreateMlServingAppResponse

        optional
        -

        The CRN of the App created.

        +

        The CRN of the Cloudera AI Inference Service created.

        string

        @@ -6773,7 +6749,7 @@

        DeleteBackupResponse

        DeleteInstanceGroupMlServingAppRequest

        -

        Request object for the DeleteInstanceGroupMLServing method.

        +

        Request object for the DeleteInstanceGroupMlServingApp method.

        @@ -6795,7 +6771,7 @@

        DeleteInstanceGroupMlServingApp required

        -

        The CRN of the MLServing App from which instance group is to be deleted.

        +

        The CRN of the Cloudera AI Inference Service from which instance group is to be deleted.

        string

        @@ -6807,7 +6783,7 @@

        DeleteInstanceGroupMlServingApp required
        -

        The instance group that we want to delete from the MLServing App.

        +

        The instance group to be deleted from the Cloudera AI Inference Service instance.

        string

        @@ -6819,7 +6795,7 @@

        DeleteInstanceGroupMlServingApp

        DeleteInstanceGroupMlServingAppResponse

        -

        Response object for the DeleteInstanceGroupMLServing method.

        +

        Response object for the DeleteInstanceGroupMlServingApp method.

        Type : object

        @@ -6905,7 +6881,7 @@

        DeleteMlServingAppRequest

        required
        -

        The CRN Of the App to delete.

        +

        The CRN of the Cloudera AI Inference Service to be deleted.

        string

        @@ -7118,7 +7094,7 @@

        DescribeMlServingAppRequest

        required
        -

        The CRN Of the App.

        +

        The CRN of the Cloudera AI Inference Service.

        string

        @@ -7152,7 +7128,7 @@

        DescribeMlServingAppResponse

        optional
        -

        The Cloudera Machine Learning Serving App

        +

        The Cloudera AI Inference Service instance.

        MlServingApp

        @@ -7783,7 +7759,7 @@

        GetLogsResponse

        GetMlServingAppKubeconfigRequest

        -

        Request object for the GetMlServingKubeconfig method.

        +

        Request object for the GetMlServingAppKubeconfig method.

        @@ -7805,7 +7781,7 @@

        GetMlServingAppKubeconfigRequest

        optional

        -

        The CRN of the app to list access.

        +

        The CRN of the Cloudera AI Inference Service instance for retrieving the kubeconfig.

        string

        @@ -7817,7 +7793,7 @@

        GetMlServingAppKubeconfigRequest

        GetMlServingAppKubeconfigResponse

        -

        Response object for the GetMlServingKubeconfig method.

        +

        Response object for the GetMlServingAppKubeconfig method.

        @@ -7839,7 +7815,7 @@

        GetMlServingAppKubeconfigResponserequired

        -

        The list of users that have access.

        +

        The kubeconfig of the Cloudera AI Inference Kubernetes cluster.

        string

        @@ -7941,7 +7917,7 @@

        GrantMlServingAppAccessRequest

        optional
        -

        The cloud provider user id, such as ARN, which will be granted access to the Model Serving App’s Kubernetes cluster.

        +

        The cloud provider user id, such as ARN, which will be granted access to the Cloudera AI Inference Service Kubernetes cluster.

        string

        @@ -7953,7 +7929,7 @@

        GrantMlServingAppAccessRequest

        optional
        -

        The CRN of the Model Serving App to grant access to.

        +

        The CRN of the Cloudera AI Inference Service instance to which access is to be granted.

        string

        @@ -8629,7 +8605,7 @@

        KubernetesCluster

        optional
        -

        The cluster CRN of an existing cluster that the AI inference App will use.

        +

        The cluster CRN of the kubernetes cluster.

        string

        @@ -8863,7 +8839,7 @@

        ListMlServingAppAccessRequest

        optional
        -

        The CRN of the Model Serving App to list access.

        +

        The CRN of the Cloudera AI Inference Service to list access.

        string

        @@ -9490,7 +9466,7 @@

        ListWorkspacesResponse

        MlServingApp

        -

        The Cloudera Machine Learning Serving App

        +

        The Cloudera AI Inference Service instance.

        @@ -9512,7 +9488,7 @@

        MlServingApp

        optional

        -

        The CRN of the App.

        +

        The CRN of the Cloudera AI Inference Service instance.

        string

        @@ -9524,7 +9500,7 @@

        MlServingApp

        optional
        -

        The name of the App.

        +

        The name of the Cloudera AI Inference Service instance.

        string

        @@ -9536,7 +9512,7 @@

        MlServingApp

        required
        -

        The cloud platform of the environment that was used to create this app.

        +

        The cloud platform of the environment that was used to create this instance.

        string

        @@ -9560,7 +9536,7 @@

        MlServingApp

        optional
        -

        Creation date of workspace.

        +

        Creation date of Cloudera AI Inference Service instance.

        string (date-time)

        @@ -9572,7 +9548,7 @@

        MlServingApp

        optional
        -

        The CRN of the environment used by App.

        +

        The CRN of the environment.

        string

        @@ -9584,7 +9560,7 @@

        MlServingApp

        optional
        -

        The name of the environment used by App.

        +

        The name of the environment.

        string

        @@ -9608,7 +9584,7 @@

        MlServingApp

        optional
        -

        Is this App installed on a private cluster.

        +

        Is this service installed on a private cluster.

        boolean

        @@ -9620,7 +9596,7 @@

        MlServingApp

        optional
        -

        The version of Cloudera Machine Learning Serving software this App is running.

        +

        The Cloudera AI Inference Service version running on this instance.

        string

        @@ -9632,7 +9608,7 @@

        MlServingApp

        optional
        -

        The namespace used the App.

        +

        The namespace used for this service.

        string

        @@ -9644,7 +9620,7 @@

        MlServingApp

        optional
        -

        The email of the user who created the App.

        +

        The email of the user who created this service.

        string

        @@ -9656,7 +9632,7 @@

        MlServingApp

        optional
        -

        The status of the MlServingApp

        +

        The status of the Cloudera AI Inference Service instance.

        string

        @@ -9668,7 +9644,7 @@

        MlServingApp

        optional
        -

        The list of subnets used for the load balancer that CML creates.

        +

        The list of subnets used for the load balancer.

        < string > array

        @@ -9680,7 +9656,7 @@

        MlServingApp

        optional
        -

        Indicates if this MlServingApp uses a public load balancer

        +

        Indicates if this Cloudera AI Inference Service instance uses a public load balancer.

        boolean

        @@ -9692,7 +9668,7 @@

        MlServingApp

        MlServingProvisionK8sRequest

        -

        Request object for CML Serving App cluster provision.

        +

        Request object for provisioning Cloudera AI Inference Service instance groups.

        @@ -10192,7 +10168,7 @@

        ModifyClusterSecurityResponse

        ModifyMlServingAppRequest

        -

        Request object for the ModifyMlServingApp.

        +

        Request object for the ModifyMlServingApp method.

        @@ -10214,7 +10190,7 @@

        ModifyMlServingAppRequest

        required

        -

        The CRN of the workspace cluster to modify.

        +

        The CRN of the Cloudera AI Inference Service to be modified.

        string

        @@ -10226,7 +10202,7 @@

        ModifyMlServingAppRequest

        required
        -

        The name of the instance group of the workspace cluster to modify.

        +

        The name of the instance group to be modified.

        string

        @@ -10238,7 +10214,7 @@

        ModifyMlServingAppRequest

        required
        -

        The desired instance type of the workspace cluster instance group.

        +

        The desired instance type of the instance group.

        string

        @@ -10250,7 +10226,7 @@

        ModifyMlServingAppRequest

        required
        -

        The desired maximum number of instances in the workspace cluster instance group.

        +

        The desired maximum number of instances in the instance group.

        integer (int32)

        @@ -10262,7 +10238,7 @@

        ModifyMlServingAppRequest

        required
        -

        The desired minimum number of instances in the workspace cluster instance group.

        +

        The desired minimum number of instances in the instance group.

        integer (int32)

        @@ -10274,7 +10250,7 @@

        ModifyMlServingAppRequest

        ModifyMlServingAppResponse

        -

        Response object for ModifyMlServingApp.

        +

        Response object for ModifyMlServingApp method.

        Type : object

        @@ -10897,7 +10873,7 @@

        ResumeWorkspaceResponse

        RevokeMlServingAppAccessRequest

        -

        Request object for the RevokeMlServingApp method.

        +

        Request object for the RevokeMlServingAppAccess method.

        @@ -10919,7 +10895,7 @@

        RevokeMlServingAppAccessRequest

        optional

        + + + + + @@ -5265,6 +5277,18 @@

        DatabaseDetails

        + + + + + @@ -8735,7 +8759,7 @@

        StorageDetailsForWorker

        StorageType

        Storage type for clusters. - CLOUD_WITH_EPHEMERAL - Cloud with ephemeral storage. CLOUD - Cloud storage without ephemeral storage. HDFS - HDFS storage.

        + CLOUD_WITH_EPHEMERAL - Cloud with ephemeral storage. CLOUD - Cloud storage without ephemeral storage. HDFS - HDFS storage. CLOUD_WITH_EPHEMERAL_DATATIERING - Cloud with Ephemeral Storage and Datatiering.

        Type : enum (CLOUD_WITH_EPHEMERAL, CLOUD, HDFS)

        @@ -8810,6 +8834,18 @@

        UpdateDatabaseRequest

        + + + + + @@ -8822,6 +8858,18 @@

        UpdateDatabaseRequest

        + + + + + @@ -8852,9 +8900,34 @@

        UpdateDatabaseResponse

        A response to database update request

        -
        -

        Type : object

        -
        +
        -

        The cloud provider user id, such as ARN, which will be granted access to the Model Serving App’s Kubernetes cluster.

        +

        The cloud provider user ID, such as ARN, from which access to the Cloudera AI Inference Service Kubernetes cluster needs to be revoked.

        string

        @@ -10931,7 +10907,7 @@

        RevokeMlServingAppAccessRequest

        optional
        -

        The CRN of the Model Serving App to grant access to.

        +

        The CRN of the Cloudera AI Inference Service instance to revoke access.

        string

        @@ -11320,7 +11296,7 @@

        UpgradeMlServingAppRequest

        required
        -

        The serving app CRN.

        +

        The Cloudera AI Inference Service CRN.

        string

        @@ -12440,7 +12416,7 @@

        WorkspaceSummary


        diff --git a/api-docs-beta/opdb/index.html b/api-docs-beta/opdb/index.html index f461ef7db..7010d0c5e 100644 --- a/api-docs-beta/opdb/index.html +++ b/api-docs-beta/opdb/index.html @@ -998,7 +998,7 @@

        Overview

        Version information

        -

        Version : 0.9.120 (BETA)

        +

        Version : 0.9.121 (BETA)

        @@ -3906,7 +3906,7 @@

        AutoScalingParameters

        optional
        -

        The maximum percentage threshold for the CPU utilization of the worker nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker nodes. Set 100 or more to disable the CPU metrics.

        +

        This configuration is effective when compute nodes are enabled. The maximum percentage threshold for the CPU utilization of nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker and compute nodes. Set 100 or more to disable the CPU metrics.

        integer (int32)

        @@ -5229,6 +5229,18 @@

        DatabaseDetails

        +

        gatewayNodesCount
        +optional

        +
        +

        Number of gateway nodes for the database.

        +
        +

        integer (int32)

        +

        hueEndpoint
        optional
        +

        restworkerNodesCount
        +optional

        +
        +

        Number of REST Worker nodes for the database.

        +
        +

        integer (int32)

        +

        scaleType
        optional
        +

        numDesiredRestworkerNodes
        +optional

        +
        +

        Sets the desired number of REST Worker nodes for the database. A positive, non-zero number is required. Requires the COD_RESTWORKERS entitlement.

        +
        +

        integer (int32)

        +

        numDesiredStrongMetaServers
        optional
        +

        removeRestworkerNodes
        +optional

        +
        +

        Removes any REST Worker nodes provisioned for this database. Requires the COD_RESTWORKERS entitlement.

        +
        +

        boolean

        +

        removeStrongMetaServers
        optional
        +++++ + + + + + + + + + + + + + + +
        NameDescriptionSchema
        +

        status
        +optional

        +
        +

        Status of whether the update was successful or not.

        +
        +

        string

        +

        UpdateEdgeNodesRequest

        @@ -9325,7 +9398,7 @@

        VolumeType


        diff --git a/api-docs-beta/replicationmanager/index.html b/api-docs-beta/replicationmanager/index.html index 523b6664c..1a47530eb 100644 --- a/api-docs-beta/replicationmanager/index.html +++ b/api-docs-beta/replicationmanager/index.html @@ -1182,7 +1182,7 @@

        Overview

        Version information

        -

        Version : 0.9.120 (BETA)

        +

        Version : 0.9.121 (BETA)

        @@ -15330,7 +15330,7 @@

        VerifyHbaseClusterPairResponse


        diff --git a/api-docs-beta/swagger/README.md b/api-docs-beta/swagger/README.md index 355d5f8a0..2bfe464af 100644 --- a/api-docs-beta/swagger/README.md +++ b/api-docs-beta/swagger/README.md @@ -1,6 +1,6 @@ # CDP Control Plane Public API Swagger Service Definitions -*Version: 0.9.120 (BETA)* +*Version: 0.9.121 (BETA)* These service definitions files are the basis for official CDP API artifacts, and you can use them to create your own client-side code. They adhere to the @@ -15,25 +15,25 @@ API requests must be signed according to the | Service Definition | Version | | --- | --- | -| [audit.yaml](./audit.yaml) | 0.9.120 | -| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.120 | -| [compute.yaml](./compute.yaml) | 0.9.120 | -| [consumption.yaml](./consumption.yaml) | 0.9.120 | -| [datacatalog.yaml](./datacatalog.yaml) | 0.9.120 | -| [datahub.yaml](./datahub.yaml) | 0.9.120 | -| [datalake.yaml](./datalake.yaml) | 0.9.120 | -| [de.yaml](./de.yaml) | 0.9.120 | -| [df.yaml](./df.yaml) | 0.9.120 | -| [dfworkload.yaml](./dfworkload.yaml) | 0.9.120 | -| [drscp.yaml](./drscp.yaml) | 0.9.120 | -| [dw.yaml](./dw.yaml) | 0.9.120 | -| [environments.yaml](./environments.yaml) | 0.9.120 | -| [iam.yaml](./iam.yaml) | 0.9.120 | -| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.120 | -| [metrics.yaml](./metrics.yaml) | 0.9.120 | -| [ml.yaml](./ml.yaml) | 0.9.120 | -| [opdb.yaml](./opdb.yaml) | 0.9.120 | -| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.120 | +| [audit.yaml](./audit.yaml) | 0.9.121 | +| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.121 | +| [compute.yaml](./compute.yaml) | 0.9.121 | +| [consumption.yaml](./consumption.yaml) | 0.9.121 | +| [datacatalog.yaml](./datacatalog.yaml) | 0.9.121 | +| [datahub.yaml](./datahub.yaml) | 0.9.121 | +| [datalake.yaml](./datalake.yaml) | 0.9.121 | +| [de.yaml](./de.yaml) | 0.9.121 | +| [df.yaml](./df.yaml) | 0.9.121 | +| [dfworkload.yaml](./dfworkload.yaml) | 0.9.121 | +| [drscp.yaml](./drscp.yaml) | 0.9.121 | +| [dw.yaml](./dw.yaml) | 0.9.121 | +| [environments.yaml](./environments.yaml) | 0.9.121 | +| [iam.yaml](./iam.yaml) | 0.9.121 | +| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.121 | +| [metrics.yaml](./metrics.yaml) | 0.9.121 | +| [ml.yaml](./ml.yaml) | 0.9.121 | +| [opdb.yaml](./opdb.yaml) | 0.9.121 | +| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.121 | See all the files at once in this site's [Github repository](https://github.com/cloudera/cdp-dev-docs/tree/master/api-docs/swagger). diff --git a/api-docs-beta/swagger/audit.yaml b/api-docs-beta/swagger/audit.yaml index aba87b70d..5a818919b 100644 --- a/api-docs-beta/swagger/audit.yaml +++ b/api-docs-beta/swagger/audit.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Audit Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/cloudprivatelinks.yaml b/api-docs-beta/swagger/cloudprivatelinks.yaml index ed0677741..f46db5b48 100644 --- a/api-docs-beta/swagger/cloudprivatelinks.yaml +++ b/api-docs-beta/swagger/cloudprivatelinks.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera CloudPrivateLinks API Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/compute.yaml b/api-docs-beta/swagger/compute.yaml index c44b5bd83..5097cbe60 100644 --- a/api-docs-beta/swagger/compute.yaml +++ b/api-docs-beta/swagger/compute.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Compute Service license: name: Apache 2.0 @@ -1365,15 +1365,9 @@ definitions: items: type: string description: Suspended processes. - stopDeleteOnError: - type: boolean - description: Whether to stop deletion on error. csiEnabled: type: boolean description: Whether CSI is enabled. - laceworkEnabled: - type: boolean - description: Whether lacework is enabled. x-form-factors: public CommonImageCatalogResp: type: object @@ -1799,60 +1793,9 @@ definitions: version: type: string description: Helm version to be upgraded to. - CommonKubernetes: - type: object - description: Kubernetes specs. Deprecated. - properties: - version: - type: string - description: Kubernetes version (default 1.28). - x-deprecated: true - CommonNetworkTopology: - type: object - description: Network topology structure. Deprecated. - properties: - subnets: - type: array - items: - type: string - description: Subnets. - x-deprecated: true CommonNetwork: type: object description: Network structure. - properties: - cidr: - type: string - description: VPC CIDR. Deprecated. - x-deprecated: true - plugin: - type: string - description: Network plugin (default multus). Deprecated. - x-deprecated: true - topology: - description: Network topology. Deprecated. - x-deprecated: true - $ref: '#/definitions/CommonNetworkTopology' - inboundProxyCidrs: - type: array - items: - type: string - description: Allow these CIDR for inbound communication when using environment proxy settings. Only if backend supports it. Deprecated. - x-deprecated: true - podCidr: - type: string - description: The pod CIDR to use if the backend provider supports setting this. - serviceCidr: - type: string - description: The CIDR for services declared inside of Kubernetes if the backend provider supports setting this. - subnets: - type: array - items: - type: string - description: Subnets. - outboundType: - type: string - description: Cluster outbound type. Currently supported is udr. CommonApiServer: type: object description: API server request structure. @@ -2015,127 +1958,6 @@ definitions: accelerator: description: Used only for GCP clusters. This is used to set GPU type and count for the cluster. $ref: '#/definitions/CommonAccelerator' - CommonYuniKorn: - type: object - description: YuniKorn request structure. Deprecated. - properties: - enabled: - type: boolean - description: Flag to enable yunikorn (default true). - version: - type: string - description: Version is ignored for overrides will be removed soon. - appSortingPolicy: - type: string - description: The app sorting policy is ignored for overrides will be removed soon. - nodeSortingPolicy: - type: string - description: The node sorting policy is ignored for overrides will be removed soon. - x-deprecated: true - CommonNvidia: - type: object - description: Nvidia request structure. Deprecated. - properties: - gpuLabelKey: - type: string - description: GPU label key. - gpuLabelValue: - type: string - description: GPU label value. - x-deprecated: true - CommonAlertmanager: - type: object - description: Alertmanager request structure. Deprecated. - properties: - enabled: - type: boolean - description: Flag to enable alertmanager. - x-deprecated: true - CommonResourceLimit: - type: object - description: Resource limits request structure. Deprecated. - properties: - cpu: - type: string - description: Prometheus server CPU limit (default 1000m). - memory: - type: string - description: Prometheus server memory limit (default 2048M). - x-deprecated: true - CommonMonitoring: - type: object - description: Monitoring request structure. Deprecated. - properties: - enabled: - type: boolean - description: Flag to enable Monitoring installation. - alertmanager: - description: Alertmanager. - $ref: '#/definitions/CommonAlertmanager' - serverResourceLimit: - description: Server resource limits. - $ref: '#/definitions/CommonResourceLimit' - x-deprecated: true - CommonMeteringService: - type: object - description: Metering service request structure. Deprecated. - properties: - serviceType: - type: string - description: Service type. - serviceVersion: - type: string - description: Service version. - workloadCrn: - type: string - description: Workload CRN. - clusterCrn: - type: string - description: Cluster CRN. - serviceConfiguration: - type: string - description: Service configuration. - x-deprecated: true - CommonMetering: - type: object - description: Metering request structure. Deprecated. - properties: - enabled: - type: boolean - description: Flag to enable metering installation. - services: - type: array - items: - $ref: '#/definitions/CommonMeteringService' - description: Array of services. - x-deprecated: true - CommonLogging: - type: object - description: Logging request structure. Deprecated. - properties: - enabled: - type: boolean - description: True to enable logging installation (default false). - x-deprecated: true - CommonIstio: - type: object - description: Istio request structure. Deprecated. - properties: - enabled: - type: boolean - description: True to enable istio installation (default true). - deploymentProfile: - type: string - description: Deployment profile to use. Currently supported are common, cml and cde (default common). - x-deprecated: true - CommonHorizontalPodAutoScaler: - type: object - description: Horizontal pod autoscaler request structure. Deprecated. - properties: - enabled: - type: boolean - description: Enable flag. - x-deprecated: true CommonAutoscaler: type: object description: Autoscaler request structure. @@ -2179,41 +2001,6 @@ definitions: scaleDownUnreadyTime: type: string description: How long an unready node should be unneeded before it is eligible for scale down. (Azure Support). - CommonDeployments: - type: object - description: Deployments request structure. Deprecated. - properties: - autoscaler: - description: Autoscaler specs. - $ref: '#/definitions/CommonAutoscaler' - horizontalPodAutoscaler: - description: Horizontal pod autoscaler specs. - $ref: '#/definitions/CommonHorizontalPodAutoScaler' - istio: - description: Istio specs. - $ref: '#/definitions/CommonIstio' - logging: - description: Logging specs. - $ref: '#/definitions/CommonLogging' - metering: - description: Metering specs. - $ref: '#/definitions/CommonMetering' - monitoring: - description: Monitoring specs. - $ref: '#/definitions/CommonMonitoring' - nvidia: - description: Nvidia specs. - $ref: '#/definitions/CommonNvidia' - repository: - type: string - description: Repository for images. - yunikorn: - description: Yunikorn specs. - $ref: '#/definitions/CommonYuniKorn' - telemetryKmsKeyArn: - type: string - description: Telemetry KMS key ARN. - x-deprecated: true CommonImageCatalog: type: object description: Image catalog request structure. @@ -2231,105 +2018,6 @@ definitions: csiEnabled: type: boolean description: Flag to enable Container Storage Interface (CSI). It further sets specific inline cloud formation policies required for CSI. - CommonClusterSpec: - type: object - description: Cluster spec request structure. Deprecated. - properties: - bootstrapScript: - type: string - description: Bootstrap script. - x-skip-logging: true - deployments: - description: Deployments. - $ref: '#/definitions/CommonDeployments' - instanceGroups: - type: array - items: - $ref: '#/definitions/CommonInstanceGroup' - description: Instance groups. - kubernetes: - description: K8s details. - $ref: '#/definitions/CommonKubernetes' - network: - description: Network. - $ref: '#/definitions/CommonNetwork' - security: - description: Security. - $ref: '#/definitions/CommonSecurity' - sshKeypairName: - type: string - description: SSH keypair. - x-sensitive: true - workerEgressRules: - type: array - items: - type: string - description: Array of egress rules of the form protocol:fromPort[:toPort[:CIDR]]. - workerIngressRules: - type: array - items: - type: string - description: Array of ingress rules of the form protocol:fromPort[:toPort[:CIDR]]. - imageCatalog: - description: The image catalog details. - $ref: '#/definitions/CommonImageCatalog' - storage: - description: The storage specifications. - $ref: '#/definitions/CommonStorageSpec' - x-deprecated: true - CommonClusterOwner: - type: object - description: Cluster owner structure. Deprecated. - properties: - email: - type: string - description: Owner's email. - firstName: - type: string - description: Owner's firstname. - lastName: - type: string - description: Owner's lastname. - userId: - type: string - description: Owner's user ID. - accountId: - type: string - description: Owner's account ID. - crn: - type: string - description: Owner's actor CRN. - x-deprecated: true - CommonClusterMetadata: - type: object - description: Cluster metadata structure. Deprecated. - properties: - environmentCrn: - type: string - description: Environment CRN. - name: - type: string - description: Cluster name. - clusterOwner: - description: Cluster owner. - $ref: '#/definitions/CommonClusterOwner' - clusterType: - type: string - description: Cluster type. Default is Shared. - description: - type: string - description: Cluster description. - labels: - type: object - description: Labels. - additionalProperties: - type: string - workloads: - type: array - items: - type: string - description: Cluster workloads. - x-deprecated: true CommonStatusMessage: type: object description: Cluster status structure. @@ -2343,18 +2031,10 @@ definitions: CreateClusterRequest: type: object description: Request object for creating a cluster. + required: + - environment + - name properties: - metadata: - description: Specifies the metadata. Deprecated. - x-deprecated: true - $ref: '#/definitions/CommonClusterMetadata' - spec: - description: Specifies the spec. Deprecated. - x-deprecated: true - $ref: '#/definitions/CommonClusterSpec' - skipValidation: - type: boolean - description: Skip validation. environment: type: string description: Environment CRN. Required. @@ -2372,19 +2052,17 @@ definitions: network: description: Network. $ref: '#/definitions/CommonNetwork' + skipValidation: + type: boolean + description: Skip validation. x-form-factors: public ValidateClusterRequest: type: object description: Request object for validating a cluster. + required: + - environment + - name properties: - metadata: - description: Specifies the metadata. Deprecated. - x-deprecated: true - $ref: '#/definitions/CommonClusterMetadata' - spec: - description: Specifies the spec. Deprecated. - x-deprecated: true - $ref: '#/definitions/CommonClusterSpec' environment: type: string description: Environment CRN. Required. diff --git a/api-docs-beta/swagger/consumption.yaml b/api-docs-beta/swagger/consumption.yaml index 6becca3fe..744df6eca 100644 --- a/api-docs-beta/swagger/consumption.yaml +++ b/api-docs-beta/swagger/consumption.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Consumption API Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datacatalog.yaml b/api-docs-beta/swagger/datacatalog.yaml index d4dbd765b..c6350cfa8 100644 --- a/api-docs-beta/swagger/datacatalog.yaml +++ b/api-docs-beta/swagger/datacatalog.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera DataCatalog Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datahub.yaml b/api-docs-beta/swagger/datahub.yaml index 7f38655f2..5db3ef209 100644 --- a/api-docs-beta/swagger/datahub.yaml +++ b/api-docs-beta/swagger/datahub.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Data hub Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datalake.yaml b/api-docs-beta/swagger/datalake.yaml index 36c2510b2..1b72a3c2a 100644 --- a/api-docs-beta/swagger/datalake.yaml +++ b/api-docs-beta/swagger/datalake.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Datalake Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/de.yaml b/api-docs-beta/swagger/de.yaml index 10e5e489a..0bc190670 100644 --- a/api-docs-beta/swagger/de.yaml +++ b/api-docs-beta/swagger/de.yaml @@ -5,7 +5,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Data Engineering license: name: Apache 2.0 @@ -357,6 +357,48 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' + /api/v1/de/upgradeService: + post: + summary: Trigger a particular step (prepare, backup, upgrade, resume) of the upgrade framework. + description: Trigger a particular step (prepare, backup, upgrade, resume) of the multi-step upgrade process. Use get-upgrade-status to know what is the next step to take. + operationId: upgradeService + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/UpgradeServiceRequest' + responses: + 200: + description: Expected response to a valid request. + schema: + $ref: '#/definitions/UpgradeServiceResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' + /api/v1/de/getUpgradeStatus: + post: + summary: Get CDE Service Upgrade Status. + description: The current status of the CDE Service upgrade. If all the steps are completed allStepsCompleted would be true. After a particular step triggered by upgrade-service is completed nextStep would point to the next step to take. + operationId: getUpgradeStatus + x-mutating: false + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/GetUpgradeStatusRequest' + responses: + 200: + description: Expected response to a valid request. + schema: + $ref: '#/definitions/GetUpgradeStatusResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' /api/v1/de/getKubeconfig: post: summary: Get Kubeconfig for the CDE service @@ -692,6 +734,12 @@ definitions: sessionTimeout: type: string description: Default timeout for Sessions. + sparkConfigs: + type: object + description: Spark configs that will be applied to all the spark jobs inside a virtual cluster. + additionalProperties: + type: string + description: Spark configs that will be applied to all the spark jobs inside a virtual cluster. VcResources: type: object properties: @@ -966,6 +1014,12 @@ definitions: items: type: string description: List of Subnet IDs of CDP subnets to use for the kubernetes worker node. + azureFilesharePrivateDNSZoneId: + type: string + description: Resource ID of custom private DNS zone for Azure storage account. + azureDatabasePrivateDNSZoneId: + type: string + description: Resource ID of the custom private DNS zone associated with the Azure database. customAzureFilesConfigs: $ref: '#/definitions/CustomAzureFilesConfigs' description: CDE uses a default public File Shares storage provisioned by AKS. Enable this option to use your own public/private File Shares. @@ -1111,6 +1165,60 @@ definitions: type: integer format: int32 description: Maximum number of spot instances for the CDE service for the All Purpose Instance Group. + UpgradeServiceRequest: + type: object + description: Request object for upgrading a service. + required: + - clusterId + - step + properties: + clusterId: + type: string + description: Cluster ID of the service to upgrade. + step: + type: string + description: The maintenance step to be performed. Currently supported steps are prepare, backup, upgrade, cancel and resume. + enum: + - prepare + - backup + - upgrade + - cancel + - resume + UpgradeServiceResponse: + type: object + description: Response object for UpgradeService request. + properties: + message: + type: string + description: The status message of upgrade operation. + default: upgrade step triggered successfully + GetUpgradeStatusRequest: + type: object + description: Request object for GetUpgradeStatus method. + required: + - clusterId + properties: + clusterId: + type: string + description: Cluster ID of the service. + GetUpgradeStatusResponse: + type: object + description: Response object for GetUpgradeStatus request. + properties: + upgradeStatusMessage: + type: string + description: The status of the upgrade. + nextStep: + type: string + description: The next step to take in multi-step upgrade process. Currently supported steps are prepare, backup, upgrade and resume. + enum: + - prepare + - backup + - upgrade + - resume + allStepsCompleted: + type: boolean + description: Whether all the steps of the multi-step upgrade process completed. UpdateServiceResponse: type: object description: Response object for UpdateService request. @@ -1316,6 +1424,12 @@ definitions: type: array items: type: string + sparkConfigs: + type: object + description: Spark configs that will be applied to all the spark jobs inside a virtual cluster. + additionalProperties: + type: string + description: Spark configs that will be applied to all the spark jobs inside a virtual cluster. CreateVcResponse: type: object description: Response object for CreateVc method. @@ -1379,6 +1493,16 @@ definitions: type: array items: type: string + sparkConfigs: + type: object + description: Spark configs that will be applied to all the spark jobs inside a virtual cluster. + additionalProperties: + type: string + description: Spark configs that will be applied to all the spark jobs inside a virtual cluster. + discardSparkConfigs: + description: Discard the Spark configs inside a VC. + type: boolean + default: false UpdateVcResponse: type: object description: Response object for updateVc method. diff --git a/api-docs-beta/swagger/df.yaml b/api-docs-beta/swagger/df.yaml index b39733b5b..040b90d6b 100644 --- a/api-docs-beta/swagger/df.yaml +++ b/api-docs-beta/swagger/df.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera DataFlow Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/dfworkload.yaml b/api-docs-beta/swagger/dfworkload.yaml index 7a22f5d62..b9b9795a5 100644 --- a/api-docs-beta/swagger/dfworkload.yaml +++ b/api-docs-beta/swagger/dfworkload.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC info: description: "This REST API provides remote access to the DataFlow Service.\n Endpoints that are marked as [BETA] are subject to change in future releases of the application without backwards compatibility and without a major version change." - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera DataFlow Workload Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/drscp.yaml b/api-docs-beta/swagger/drscp.yaml index 325c054e7..e9573d995 100644 --- a/api-docs-beta/swagger/drscp.yaml +++ b/api-docs-beta/swagger/drscp.yaml @@ -5,7 +5,7 @@ x-form-factors: private x-audit: true x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: CDP Control Plane Data Recovery Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/dw.yaml b/api-docs-beta/swagger/dw.yaml index 5f14d769e..19f7333be 100644 --- a/api-docs-beta/swagger/dw.yaml +++ b/api-docs-beta/swagger/dw.yaml @@ -4,7 +4,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Data Warehouse [EXPERIMENTAL] license: name: Apache 2.0 @@ -547,27 +547,6 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' - /api/v1/dw/upgradeCluster: - post: - x-mutating: true - summary: Upgrade the Cloudera Data Warehouse cluster. - description: Upgrade the Cloudera Data Warehouse cluster to the latest supported version. Expect downtime during the upgrade and refrain issuing queries. You can check the current status of the cluster with the describe-cluster command. - operationId: upgradeCluster - parameters: - - name: input - in: body - required: true - schema: - $ref: '#/definitions/UpgradeClusterRequest' - responses: - 200: - description: Expected response to a valid request. - schema: - $ref: '#/definitions/UpgradeClusterResponse' - default: - description: The default response on an error. - schema: - $ref: '#/definitions/Error' /api/v1/dw/backupCluster: post: x-mutating: true @@ -2493,11 +2472,10 @@ definitions: type: boolean description: Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role. computeInstanceTypes: - x-deprecated: true type: array items: type: string - description: 'DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.' + description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.' additionalInstanceTypes: x-deprecated: true type: array @@ -2566,11 +2544,10 @@ definitions: description: Whether to enable spot instances for Virtual warehouses. It cannot be updated later. Defaults to false. default: false computeInstanceTypes: - x-deprecated: true type: array items: type: string - description: 'DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.' + description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.' logAnalyticsWorkspaceId: type: string description: Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics. @@ -2764,22 +2741,12 @@ definitions: enum: - ACR - ECR - - Docker type: string description: Custom registry type. repositoryUrl: type: string description: URL of the custom image repository. x-no-paramfile: true - userName: - type: string - description: Username for custom registry access (required only for Docker type). - password: - type: string - description: Password for custom registry access (required only for Docker type). - disableImageVerification: - type: boolean - description: Disable image verification. AwsActivationOptions: type: object description: Options for activating an AWS environment. @@ -2812,11 +2779,10 @@ definitions: type: boolean description: Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role. computeInstanceTypes: - x-deprecated: true type: array items: type: string - description: 'DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.' + description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.' additionalInstanceTypes: x-deprecated: true type: array @@ -2841,11 +2807,10 @@ definitions: description: Whether to enable spot instances for Virtual warehouses. It cannot be updated later. If the AzureActivationOptions is not provided it defaults to false. default: false computeInstanceTypes: - x-deprecated: true type: array items: type: string - description: 'DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.' + description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.' logAnalyticsWorkspaceId: type: string description: Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics. @@ -2956,31 +2921,6 @@ definitions: DeleteClusterResponse: type: object description: Response object for the deleteCluster method. - UpgradeClusterRequest: - type: object - description: Request object for the upgradeCluster method. - required: - - clusterId - properties: - clusterId: - type: string - description: The ID of the cluster to upgrade. - UpgradeClusterResponse: - type: object - description: Response object for the upgradeCluster method. - properties: - status: - type: string - description: 'The upgrade status. Possible values are: Upgrading, Error, Failed.' - message: - type: string - description: Detailed explanation of the status. - timedOut: - type: boolean - description: True if the upgrade timed out, false or omitted otherwise. - serviceUnhealthy: - type: boolean - description: True, if the service is in unhealthy state, false or omitted otherwise. UpdateClusterRequest: type: object description: Request object for the updateCluster method. @@ -4993,11 +4933,10 @@ definitions: format: int32 description: Number of additional reserved nodes for other services in the cluster. computeInstanceTypes: - x-deprecated: true type: array items: type: string - description: 'DEPRECATED: The cluster level instance type selection will be replaced by virtual warehouse level selection. Compute instance types that the environment is restricted to use. This affects the creation of the virtual warehouses where this restriction will apply.' + description: 'NOTE: The cluster level instance type selection will be replaced by virtual warehouse level selection. Compute instance types that the environment is restricted to use. This affects the creation of the virtual warehouses where this restriction will apply.' additionalInstanceTypes: x-deprecated: true type: array diff --git a/api-docs-beta/swagger/environments.yaml b/api-docs-beta/swagger/environments.yaml index 3c05352aa..5421868d2 100644 --- a/api-docs-beta/swagger/environments.yaml +++ b/api-docs-beta/swagger/environments.yaml @@ -6,7 +6,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Environments Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/iam.yaml b/api-docs-beta/swagger/iam.yaml index 372033dbe..a7f274447 100644 --- a/api-docs-beta/swagger/iam.yaml +++ b/api-docs-beta/swagger/iam.yaml @@ -7,7 +7,7 @@ x-cdp-releases: PUBLIC x-audit: true x-extensions: pvcapipath info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera IAM Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/imagecatalog.yaml b/api-docs-beta/swagger/imagecatalog.yaml index 95cf7281b..7647de6a6 100644 --- a/api-docs-beta/swagger/imagecatalog.yaml +++ b/api-docs-beta/swagger/imagecatalog.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Image catalog service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/metrics.yaml b/api-docs-beta/swagger/metrics.yaml index f7c71cb4d..0aa2c30f9 100644 --- a/api-docs-beta/swagger/metrics.yaml +++ b/api-docs-beta/swagger/metrics.yaml @@ -14,7 +14,7 @@ info: license: name: Apache 2.0 title: Cloudera Control Plane Monitoring Metrics Administration - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) x-audit: true paths: /api/v1/metrics/createRemoteWriteConfig: diff --git a/api-docs-beta/swagger/ml.yaml b/api-docs-beta/swagger/ml.yaml index b430f9346..5e5d1f48d 100644 --- a/api-docs-beta/swagger/ml.yaml +++ b/api-docs-beta/swagger/ml.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Machine Learning license: name: Apache 2.0 @@ -20,8 +20,8 @@ produces: paths: /api/v1/ml/addInstanceGroupsMlServingApp: post: - summary: Add new Cloudera Machine Learning Serving App's cluster instance groups. - description: Add new Cloudera Machine Learning Serving App's cluster instance groups. + summary: Add instance group to an existing Cloudera AI Inference Service instance. + description: Add instance group to an existing Cloudera AI Inference Service instance. operationId: addInstanceGroupsMlServingApp parameters: - name: input @@ -62,8 +62,8 @@ paths: x-mutating: true /api/v1/ml/createMlServingApp: post: - summary: Create a Cloudera Machine Learning Serving App. - description: Provision a Kubernetes cluster and install the Cloudera Machine Learning application in it. + summary: Deploys Cloudera AI Inference Service into an existing Kubernetes cluster. + description: Deploys Cloudera AI Inference Service into an existing Kubernetes cluster. operationId: createMlServingApp parameters: - name: input @@ -167,8 +167,8 @@ paths: x-mutating: true /api/v1/ml/deleteInstanceGroupMlServingApp: post: - summary: Deletes an instance group from the cluster. - description: Deletes an instance group from a Cloudera Machine Serving App's cluster. + summary: Deletes an instance group from a Cloudera AI Inference Service instance. + description: Deletes an instance group from a Cloudera AI Inference Service instance. operationId: deleteInstanceGroupMlServingApp parameters: - name: input @@ -188,8 +188,8 @@ paths: x-mutating: true /api/v1/ml/deleteMlServingApp: post: - summary: Deletes Cloudera Machine Learning Serving App. - description: Gracefully deletes the CML Serve App. + summary: Deletes Cloudera AI Inference Service instance. + description: Gracefully deletes the Cloudera AI Inference Service instance without deleting the cluster. operationId: deleteMlServingApp parameters: - name: input @@ -251,8 +251,8 @@ paths: x-mutating: true /api/v1/ml/describeMlServingApp: post: - summary: Describe Cloudera Machine Learning Serving App. - description: Describe Cloudera Machine Learning Serving App. + summary: Describe Cloudera AI Inference Service instance. + description: Describe Cloudera AI Inference Service instance. operationId: describeMlServingApp parameters: - name: input @@ -398,8 +398,8 @@ paths: x-mutating: false /api/v1/ml/getMlServingAppKubeconfig: post: - summary: Return kubeconfig for Ml Serving App. - description: Gets the Kubeconfig of the Ml Serving cluster. + summary: Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster. + description: Gets the Kubeconfig of the Cloudera AI Inference Service kubernetes cluster. operationId: getMlServingAppKubeconfig parameters: - name: input @@ -440,8 +440,8 @@ paths: x-mutating: false /api/v1/ml/grantMlServingAppAccess: post: - summary: Grant access to Cloudera Machine Learning Model Serving App. - description: Grants an AWS user to perform Kubernetes operations on a Cloudera Machine Learning Model Serving App. + summary: Grants admin access to a Cloudera AI Inference Service cluster. + description: Grants an AWS user permissions to perform Kubernetes operations on a Cloudera AI Inference Service cluster. operationId: grantMlServingAppAccess parameters: - name: input @@ -524,8 +524,8 @@ paths: x-mutating: false /api/v1/ml/listMlServingAppAccess: post: - summary: List member access for Cloudera Machine Learning Model Serving App. - description: Lists users that can perform Kubernetes operations on a Cloudera Machine Learning Model Serving App + summary: List members that have Kubernetes access to a Cloudera AI Inference Service cluster. + description: Lists users that can perform Kubernetes operations on a Cloudera AI Inference Service cluster. operationId: listMlServingAppAccess parameters: - name: input @@ -545,8 +545,8 @@ paths: x-mutating: false /api/v1/ml/listMlServingApps: post: - summary: List all Cloudera Machine Learning Serving Apps. - description: List all Cloudera Machine Learning Serving Apps. + summary: List all Cloudera AI Inference Service instances. + description: List all Cloudera AI Inference Service instances. operationId: listMlServingApps parameters: - name: input @@ -734,8 +734,8 @@ paths: x-mutating: true /api/v1/ml/modifyMlServingApp: post: - summary: Modify a Cloudera Machine Learning Serving App's cluster instance group. - description: Modify a Cloudera Machine Learning Serving App's cluster instance group. + summary: Modify instance groups for a Cloudera AI Inference Service cluster. + description: Modify instance groups for a Cloudera AI Inference Service cluster. operationId: modifyMlServingApp parameters: - name: input @@ -860,8 +860,8 @@ paths: x-mutating: true /api/v1/ml/revokeMlServingAppAccess: post: - summary: Revoke access to Cloudera Machine Learning Model Serving App. - description: Revokes an AWS user to perform Kubernetes operations on a Cloudera Machine Learning Model Serving App. + summary: Revokes access to a Cloudera AI Inference Service cluster. + description: Revokes an AWS user permissions on a Cloudera AI Inference Service cluster. operationId: revokeMlServingAppAccess parameters: - name: input @@ -965,8 +965,8 @@ paths: x-mutating: true /api/v1/ml/upgradeMlServingApp: post: - summary: Upgrade a Cloudera Machine Learning Serving App. - description: Upgrades a Cloudera Machine Learning Serving App to the latest available version. + summary: Upgrade a Cloudera AI Inference Service instance. + description: Upgrade a Cloudera AI Inference Service instance to the latest available version. operationId: upgradeMlServingApp parameters: - name: input @@ -1378,38 +1378,38 @@ definitions: x-sensitive: true DeleteInstanceGroupMlServingAppRequest: type: object - description: Request object for the DeleteInstanceGroupMLServing method. + description: Request object for the DeleteInstanceGroupMlServingApp method. required: - appCrn - instanceGroupName properties: appCrn: type: string - description: The CRN of the MLServing App from which instance group is to be deleted. + description: The CRN of the Cloudera AI Inference Service from which instance group is to be deleted. instanceGroupName: type: string - description: The instance group that we want to delete from the MLServing App. + description: The instance group to be deleted from the Cloudera AI Inference Service instance. DeleteInstanceGroupMlServingAppResponse: type: object - description: Response object for the DeleteInstanceGroupMLServing method. + description: Response object for the DeleteInstanceGroupMlServingApp method. AddInstanceGroupsMlServingAppRequest: type: object - description: Request object for AddInstanceGroupsMlServing method. + description: Request object for AddInstanceGroupsMlServingApp method. required: - appCrn - instanceGroups properties: appCrn: type: string - description: The CRN of the MLServing App to which the instance groups are to be added. + description: The CRN of the Cloudera AI Inference Service instance to which the instance groups will be added. instanceGroups: type: array items: $ref: '#/definitions/InstanceGroup' - description: The instance groups that we want to add to the MLServing App. + description: The instance groups to be added to the Cloudera AI Inference Service instance. AddInstanceGroupsMlServingAppResponse: type: object - description: Response object for AddInstanceGroupsMlServing. + description: Response object for AddInstanceGroupsMlServingApp method. CreateWorkspaceRequest: type: object description: Request object for the CreateWorkspace method. @@ -2045,11 +2045,11 @@ definitions: description: The CRN of the workspace to list access. GetMlServingAppKubeconfigRequest: type: object - description: Request object for the GetMlServingKubeconfig method. + description: Request object for the GetMlServingAppKubeconfig method. properties: appCrn: type: string - description: The CRN of the app to list access. + description: The CRN of the Cloudera AI Inference Service instance for retrieving the kubeconfig. GetModelRegistryKubeconfigRequest: type: object description: Request object for GetModelRegistryKubeconfig. @@ -2076,13 +2076,13 @@ definitions: x-sensitive: true GetMlServingAppKubeconfigResponse: type: object - description: Response object for the GetMlServingKubeconfig method. + description: Response object for the GetMlServingAppKubeconfig method. required: - kubeconfig properties: kubeconfig: type: string - description: The list of users that have access. + description: The kubeconfig of the Cloudera AI Inference Kubernetes cluster. x-sensitive: true GetLatestWorkspaceVersionRequest: type: object @@ -2558,30 +2558,23 @@ definitions: required: - appName - environmentCrn - - mlservingVersion - clusterCrn properties: appName: type: string - description: The name of the App to create. + description: The name of the Cloudera AI Inference Service to be created. environmentCrn: type: string - description: The environment CRN for the App. - mlservingVersion: - type: string - description: The version of ML workload app to install. + description: The environment CRN. clusterCrn: type: string - description: The cluster CRN of an existing cluster that the AI inference App will use. + description: The cluster CRN of an existing cluster where Cloudera AI Inference Service instance will be deployed. provisionK8sRequest: description: The request for Kubernetes cluster provisioning. Required in public cloud. $ref: '#/definitions/MlServingProvisionK8sRequest' usePublicLoadBalancer: type: boolean description: The boolean flag to request a public load balancer. By default, a private load balancer is used. - disableTLS: - type: boolean - description: The boolean flag to disable TLS setup for MlServingApp. By default, the TLS is enabled. skipValidation: type: boolean description: Skip pre-flight validations if requested. @@ -2594,17 +2587,17 @@ definitions: type: array items: type: string - description: The list of subnets used for the load balancer that CML creates. + description: The list of subnets to be used for the load balancer. staticSubdomain: type: string - description: The static subdomain to be used for the serving app. + description: The static subdomain to be used for the Cloudera AI Inference Service instance. CreateMlServingAppResponse: type: object description: Response object for the CreateMlServingApp method. properties: appCrn: type: string - description: The CRN of the App created. + description: The CRN of the Cloudera AI Inference Service created. UpgradeMlServingAppRequest: type: object description: Request object for the UpgradeMlServingApp method. @@ -2613,7 +2606,7 @@ definitions: properties: appCrn: type: string - description: The serving app CRN. + description: The Cloudera AI Inference Service CRN. UpgradeMlServingAppResponse: type: object description: Response object for the UpgradeMlServingApp method. @@ -2625,13 +2618,13 @@ definitions: properties: appCrn: type: string - description: The CRN Of the App to delete. + description: The CRN of the Cloudera AI Inference Service to be deleted. DeleteMlServingAppResponse: type: object description: Response object for the DeleteMlServingApp method. MlServingProvisionK8sRequest: type: object - description: Request object for CML Serving App cluster provision. + description: Request object for provisioning Cloudera AI Inference Service instance groups. required: - instanceGroups - environmentCrn @@ -2678,60 +2671,60 @@ definitions: properties: appCrn: type: string - description: The CRN Of the App. + description: The CRN of the Cloudera AI Inference Service. DescribeMlServingAppResponse: type: object description: Response object for the DescribeMlServingApp method. properties: app: - description: The Cloudera Machine Learning Serving App + description: The Cloudera AI Inference Service instance. $ref: '#/definitions/MlServingApp' MlServingApp: type: object - description: The Cloudera Machine Learning Serving App + description: The Cloudera AI Inference Service instance. required: - cloudPlatform properties: cloudPlatform: type: string - description: The cloud platform of the environment that was used to create this app. + description: The cloud platform of the environment that was used to create this instance. appName: type: string - description: The name of the App. + description: The name of the Cloudera AI Inference Service instance. appCrn: type: string - description: The CRN of the App. + description: The CRN of the Cloudera AI Inference Service instance. environmentCrn: type: string - description: The CRN of the environment used by App. + description: The CRN of the environment. environmentName: type: string - description: The name of the environment used by App. + description: The name of the environment. namespace: type: string - description: The namespace used the App. + description: The namespace used for this service. ownerEmail: type: string - description: The email of the user who created the App. + description: The email of the user who created this service. mlServingVersion: type: string - description: The version of Cloudera Machine Learning Serving software this App is running. + description: The Cloudera AI Inference Service version running on this instance. isPrivateCluster: type: boolean - description: Is this App installed on a private cluster. + description: Is this service installed on a private cluster. creationDate: type: string format: date-time - description: Creation date of workspace. + description: Creation date of Cloudera AI Inference Service instance. cluster: description: The Kubernetes cluster information. $ref: '#/definitions/KubernetesCluster' status: type: string - description: The status of the MlServingApp + description: The status of the Cloudera AI Inference Service instance. usePublicLoadBalancer: type: boolean - description: Indicates if this MlServingApp uses a public load balancer + description: Indicates if this Cloudera AI Inference Service instance uses a public load balancer. httpsEnabled: type: boolean description: Indicates if HTTPs communication was enabled on this application when it was provisioned. @@ -2739,7 +2732,7 @@ definitions: type: array items: type: string - description: The list of subnets used for the load balancer that CML creates. + description: The list of subnets used for the load balancer. KubernetesCluster: type: object description: The Kubernetes cluster information @@ -2783,7 +2776,7 @@ definitions: description: The instance groups. clusterCrn: type: string - description: The cluster CRN of an existing cluster that the AI inference App will use. + description: The cluster CRN of the kubernetes cluster. ListRelevantInstancesRequest: type: object description: Request object for the ListRelevantInstances method. @@ -2922,10 +2915,10 @@ definitions: properties: resourceCrn: type: string - description: The CRN of the Model Serving App to grant access to. + description: The CRN of the Cloudera AI Inference Service instance to which access is to be granted. identifier: type: string - description: The cloud provider user id, such as ARN, which will be granted access to the Model Serving App's Kubernetes cluster. + description: The cloud provider user id, such as ARN, which will be granted access to the Cloudera AI Inference Service Kubernetes cluster. GrantMlServingAppAccessResponse: type: object description: Response object for the GrantMlServingAppAccess method. @@ -2938,14 +2931,14 @@ definitions: x-sensitive: true RevokeMlServingAppAccessRequest: type: object - description: Request object for the RevokeMlServingApp method. + description: Request object for the RevokeMlServingAppAccess method. properties: resourceCrn: type: string - description: The CRN of the Model Serving App to grant access to. + description: The CRN of the Cloudera AI Inference Service instance to revoke access. identifier: type: string - description: The cloud provider user id, such as ARN, which will be granted access to the Model Serving App's Kubernetes cluster. + description: The cloud provider user ID, such as ARN, from which access to the Cloudera AI Inference Service Kubernetes cluster needs to be revoked. RevokeMlServingAppAccessResponse: type: object description: Response object for the RevokeMlServingAppAccess method. @@ -2955,7 +2948,7 @@ definitions: properties: resourceCrn: type: string - description: The CRN of the Model Serving App to list access. + description: The CRN of the Cloudera AI Inference Service to list access. ListMlServingAppAccessResponse: type: object description: Response object for the ListMlServingAppAccess method. @@ -2971,7 +2964,7 @@ definitions: x-sensitive: true ModifyMlServingAppRequest: type: object - description: Request object for the ModifyMlServingApp. + description: Request object for the ModifyMlServingApp method. required: - appCrn - instanceGroupName @@ -2981,22 +2974,22 @@ definitions: properties: appCrn: type: string - description: The CRN of the workspace cluster to modify. + description: The CRN of the Cloudera AI Inference Service to be modified. instanceGroupName: type: string - description: The name of the instance group of the workspace cluster to modify. + description: The name of the instance group to be modified. min: type: integer format: int32 - description: The desired minimum number of instances in the workspace cluster instance group. + description: The desired minimum number of instances in the instance group. max: type: integer format: int32 - description: The desired maximum number of instances in the workspace cluster instance group. + description: The desired maximum number of instances in the instance group. instanceType: type: string - description: The desired instance type of the workspace cluster instance group. + description: The desired instance type of the instance group. ModifyMlServingAppResponse: type: object - description: Response object for ModifyMlServingApp. + description: Response object for ModifyMlServingApp method. x-audit: true diff --git a/api-docs-beta/swagger/opdb.yaml b/api-docs-beta/swagger/opdb.yaml index 57460303e..39faa074d 100644 --- a/api-docs-beta/swagger/opdb.yaml +++ b/api-docs-beta/swagger/opdb.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Operational Database service license: name: Apache 2.0 @@ -871,7 +871,7 @@ definitions: - HEAVY StorageType: type: string - description: "Storage type for clusters.\n `CLOUD_WITH_EPHEMERAL` - Cloud with ephemeral storage. `CLOUD` - Cloud storage without ephemeral storage. `HDFS` - HDFS storage." + description: "Storage type for clusters.\n `CLOUD_WITH_EPHEMERAL` - Cloud with ephemeral storage. `CLOUD` - Cloud storage without ephemeral storage. `HDFS` - HDFS storage. `CLOUD_WITH_EPHEMERAL_DATATIERING` - Cloud with Ephemeral Storage and Datatiering." enum: - CLOUD_WITH_EPHEMERAL - CLOUD @@ -905,6 +905,13 @@ definitions: verticalScale: description: Vertical Scale request for database. $ref: '#/definitions/GroupType' + numDesiredRestworkerNodes: + type: integer + format: int32 + description: Sets the desired number of REST Worker nodes for the database. A positive, non-zero number is required. Requires the COD_RESTWORKERS entitlement. + removeRestworkerNodes: + type: boolean + description: Removes any REST Worker nodes provisioned for this database. Requires the COD_RESTWORKERS entitlement. AutoScalingParameters: type: object description: A Parameters to configure AutoScaling @@ -944,7 +951,7 @@ definitions: maxCpuUtilization: type: integer format: int32 - description: The maximum percentage threshold for the CPU utilization of the worker nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker nodes. Set 100 or more to disable the CPU metrics. + description: This configuration is effective when compute nodes are enabled. The maximum percentage threshold for the CPU utilization of nodes. The CPU utilization is obtained from the Cloudera Manager metric 'cpu_percent' across worker and compute nodes. Set 100 or more to disable the CPU metrics. maxComputeNodesForDatabase: type: integer format: int32 @@ -1017,6 +1024,10 @@ definitions: UpdateDatabaseResponse: type: object description: A response to database update request + properties: + status: + type: string + description: Status of whether the update was successful or not. ConfigurationType: type: string description: "Type of an HBase configuration.\n `SERVICE` - Service level configuration. `MASTER` - Configuration for the Master nodes. `REGIONSERVER` - Configuration for the RegionServer nodes. `STRONGMETA` - Configuration for the StrongMeta RegionServer nodes. `GATEWAY` - Configuration for the Gateway nodes." @@ -1286,6 +1297,14 @@ definitions: type: integer format: int32 description: Total number of compute nodes in the database (including stopped nodes). + gatewayNodesCount: + type: integer + format: int32 + description: Number of gateway nodes for the database. + restworkerNodesCount: + type: integer + format: int32 + description: Number of REST Worker nodes for the database. StorageDetailsForWorker: type: object description: Storage details for the worker node for AWS, Azure, and GCP cloud providers. diff --git a/api-docs-beta/swagger/replicationmanager.yaml b/api-docs-beta/swagger/replicationmanager.yaml index 398c9d217..e73e39788 100644 --- a/api-docs-beta/swagger/replicationmanager.yaml +++ b/api-docs-beta/swagger/replicationmanager.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.120 (BETA) + version: 0.9.121 (BETA) title: Cloudera Replication Manager Service license: name: Apache 2.0