From e51269ae17c4966b32b28ea2925e3fd8bd63bffb Mon Sep 17 00:00:00 2001 From: Ionos Cloud SDK Robot Date: Tue, 10 Dec 2024 13:20:47 +0000 Subject: [PATCH] auto-generated version 1.1.1 --- README.md | 189 ++++++++++-------------- api_data_platform_cluster.go | 2 +- api_data_platform_meta_data.go | 2 +- api_data_platform_node_pool.go | 2 +- client.go | 6 +- configuration.go | 6 +- docs/models/AutoScaling.md | 69 +++++++++ docs/models/AutoScalingBase.md | 69 +++++++++ docs/models/CreateNodePoolProperties.md | 26 ++++ docs/models/NodePool.md | 26 ++++ docs/models/PatchNodePoolProperties.md | 36 +++++ docs/summary.md | 2 + logger.go | 2 +- model_auto_scaling.go | 169 +++++++++++++++++++++ model_auto_scaling_base.go | 169 +++++++++++++++++++++ model_availability_zone.go | 2 +- model_cluster.go | 2 +- model_cluster_list_response_data.go | 2 +- model_cluster_response_data.go | 2 +- model_create_cluster_properties.go | 2 +- model_create_cluster_request.go | 2 +- model_create_node_pool_properties.go | 45 +++++- model_create_node_pool_request.go | 2 +- model_error_message.go | 2 +- model_error_response.go | 2 +- model_lan.go | 2 +- model_maintenance_window.go | 2 +- model_metadata.go | 2 +- model_node_pool.go | 45 +++++- model_node_pool_list_response_data.go | 2 +- model_node_pool_response_data.go | 2 +- model_patch_cluster_properties.go | 2 +- model_patch_cluster_request.go | 2 +- model_patch_node_pool_properties.go | 43 +++++- model_patch_node_pool_request.go | 2 +- model_route.go | 2 +- model_storage_type.go | 2 +- model_versions_get_200_response.go | 2 +- response.go | 2 +- utils.go | 2 +- 40 files changed, 808 insertions(+), 144 deletions(-) create mode 100644 docs/models/AutoScaling.md create mode 100644 docs/models/AutoScalingBase.md create mode 100644 model_auto_scaling.go create mode 100644 model_auto_scaling_base.go diff --git a/README.md b/README.md index 05b6ec0..4b55c9c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Gitter](https://img.shields.io/gitter/room/ionos-cloud/sdk-general)](https://gitter.im/ionos-cloud/sdk-general) + # Go API client for ionoscloud *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster @@ -140,8 +142,8 @@ and can only be modified or deleted via the API. ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 1.1.0 -- Package version: 1.1.0 +- API version: 1.2.0 +- Package version: 1.1.1 - Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit [https://www.ionos.com](https://www.ionos.com) @@ -151,139 +153,108 @@ Install the following dependencies: ```shell go get github.com/stretchr/testify/assert +go get golang.org/x/oauth2 go get golang.org/x/net/context +go get github.com/antihax/optional ``` Put the package under your project folder and add the following in import: ```golang -import ionoscloud "github.com/ionos-cloud/sdk-go-dataplatform" +import "./ionoscloud" ``` -To use a proxy, set the environment variable `HTTP_PROXY`: - -```golang -os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port") -``` +## Authentication -## Configuration of Server URL +All available server URLs are: -Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification. +- *https://api.ionos.com/dataplatform* - IONOS Cloud - Managed Stackable Data Platform API -### Select Server Configuration +By default, *https://api.ionos.com/dataplatform* is used, however this can be overriden at authentication, either +by setting the `IONOS_API_URL` environment variable or by specifying the `hostUrl` parameter when +initializing the sdk client. -For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`. +The username and password or the authentication token can be manually specified when initializing +the sdk client: ```golang -ctx := context.WithValue(context.Background(), ionoscloud.ContextServerIndex, 1) -``` - -### Templated Server URL -Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`. +client := ionoscloud.NewAPIClient(ionoscloud.NewConfiguration(username, password, token, hostUrl)) -```golang -ctx := context.WithValue(context.Background(), ionoscloud.ContextServerVariables, map[string]string{ - "basePath": "v2", -}) ``` -Note, enum values are always validated and all unused variables are silently ignored. - -## Documentation for API Endpoints - -All URIs are relative to *https://api.ionos.com/dataplatform* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DataPlatformClusterApi* | [**ClustersDelete**](docs/api/DataPlatformClusterApi.md#clustersdelete) | **Delete** /clusters/{clusterId} | Delete a DataPlatformCluster -*DataPlatformClusterApi* | [**ClustersFindById**](docs/api/DataPlatformClusterApi.md#clustersfindbyid) | **Get** /clusters/{clusterId} | Retrieve a DataPlatformCluster -*DataPlatformClusterApi* | [**ClustersGet**](docs/api/DataPlatformClusterApi.md#clustersget) | **Get** /clusters | List the DataPlatformClusters -*DataPlatformClusterApi* | [**ClustersKubeconfigFindByClusterId**](docs/api/DataPlatformClusterApi.md#clusterskubeconfigfindbyclusterid) | **Get** /clusters/{clusterId}/kubeconfig | Read the Kubeconfig -*DataPlatformClusterApi* | [**ClustersPatch**](docs/api/DataPlatformClusterApi.md#clusterspatch) | **Patch** /clusters/{clusterId} | Partially Modify a DataPlatformCluster -*DataPlatformClusterApi* | [**ClustersPost**](docs/api/DataPlatformClusterApi.md#clusterspost) | **Post** /clusters | Create a DataPlatformCluster -*DataPlatformMetaDataApi* | [**VersionsGet**](docs/api/DataPlatformMetaDataApi.md#versionsget) | **Get** /versions | Managed Stackable Data Platform API Versions -*DataPlatformNodePoolApi* | [**ClustersNodepoolsDelete**](docs/api/DataPlatformNodePoolApi.md#clustersnodepoolsdelete) | **Delete** /clusters/{clusterId}/nodepools/{nodepoolId} | Remove a DataPlatformNodePool from a DataPlatformCluster -*DataPlatformNodePoolApi* | [**ClustersNodepoolsFindById**](docs/api/DataPlatformNodePoolApi.md#clustersnodepoolsfindbyid) | **Get** /clusters/{clusterId}/nodepools/{nodepoolId} | Retrieve a DataPlatformNodePool -*DataPlatformNodePoolApi* | [**ClustersNodepoolsGet**](docs/api/DataPlatformNodePoolApi.md#clustersnodepoolsget) | **Get** /clusters/{clusterId}/nodepools | List the DataPlatformNodePools of a DataPlatformCluster -*DataPlatformNodePoolApi* | [**ClustersNodepoolsPatch**](docs/api/DataPlatformNodePoolApi.md#clustersnodepoolspatch) | **Patch** /clusters/{clusterId}/nodepools/{nodepoolId} | Partially Modify a DataPlatformNodePool -*DataPlatformNodePoolApi* | [**ClustersNodepoolsPost**](docs/api/DataPlatformNodePoolApi.md#clustersnodepoolspost) | **Post** /clusters/{clusterId}/nodepools | Create a DataPlatformNodePool for a distinct DataPlatformCluster - +Environment variables can also be used. The sdk uses the following variables: +- IONOS_TOKEN - login via token. This is the recommended way to authenticate. +- IONOS_USERNAME - to specify the username used to login +- IONOS_PASSWORD - to specify the password +- IONOS_API_URL - to specify the API server URL -## Documentation For Models - - - [AvailabilityZone](docs/models/AvailabilityZone.md) - - [Cluster](docs/models/Cluster.md) - - [ClusterListResponseData](docs/models/ClusterListResponseData.md) - - [ClusterResponseData](docs/models/ClusterResponseData.md) - - [CreateClusterProperties](docs/models/CreateClusterProperties.md) - - [CreateClusterRequest](docs/models/CreateClusterRequest.md) - - [CreateNodePoolProperties](docs/models/CreateNodePoolProperties.md) - - [CreateNodePoolRequest](docs/models/CreateNodePoolRequest.md) - - [ErrorMessage](docs/models/ErrorMessage.md) - - [ErrorResponse](docs/models/ErrorResponse.md) - - [Lan](docs/models/Lan.md) - - [MaintenanceWindow](docs/models/MaintenanceWindow.md) - - [Metadata](docs/models/Metadata.md) - - [NodePool](docs/models/NodePool.md) - - [NodePoolListResponseData](docs/models/NodePoolListResponseData.md) - - [NodePoolResponseData](docs/models/NodePoolResponseData.md) - - [PatchClusterProperties](docs/models/PatchClusterProperties.md) - - [PatchClusterRequest](docs/models/PatchClusterRequest.md) - - [PatchNodePoolProperties](docs/models/PatchNodePoolProperties.md) - - [PatchNodePoolRequest](docs/models/PatchNodePoolRequest.md) - - [Route](docs/models/Route.md) - - [StorageType](docs/models/StorageType.md) - - [VersionsGet200Response](docs/models/VersionsGet200Response.md) - - -## Documentation For Authorization - - -Authentication schemes defined for the API: -### tokenAuth - -- **Type**: HTTP Bearer token authentication - -Example +In this case, the client configuration needs to be initialized using `NewConfigurationFromEnv()`. ```golang -auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") -r, err := client.Service.Operation(auth, args) -``` - -### basicAuth -- **Type**: HTTP basic authentication +client := ionoscloud.NewAPIClient(ionoscloud.NewConfigurationFromEnv()) -Example - -```golang -auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ - UserName: "username", - Password: "password", -}) -r, err := client.Service.Operation(auth, args) ``` -## Documentation for Utility Methods - -Due to the fact that model structure members are all pointers, this package contains -a number of utility functions to easily obtain pointers to values of basic types. -Each of these functions takes a value of the given basic type and returns a pointer to it: - -* `PtrBool` -* `PtrInt` -* `PtrInt32` -* `PtrInt64` -* `PtrFloat` -* `PtrFloat32` -* `PtrFloat64` -* `PtrString` -* `PtrTime` - -## Author +## Documentation for API Endpoints +All URIs are relative to *https://api.ionos.com/dataplatform* +
+ API Endpoints table + + +| Class | Method | HTTP request | Description | +| ------------- | ------------- | ------------- | ------------- | +| DataPlatformClusterApi | [**ClustersDelete**](docs/api/DataPlatformClusterApi.md#ClustersDelete) | **Delete** /clusters/{clusterId} | Delete a DataPlatformCluster | +| DataPlatformClusterApi | [**ClustersFindById**](docs/api/DataPlatformClusterApi.md#ClustersFindById) | **Get** /clusters/{clusterId} | Retrieve a DataPlatformCluster | +| DataPlatformClusterApi | [**ClustersGet**](docs/api/DataPlatformClusterApi.md#ClustersGet) | **Get** /clusters | List the DataPlatformClusters | +| DataPlatformClusterApi | [**ClustersKubeconfigFindByClusterId**](docs/api/DataPlatformClusterApi.md#ClustersKubeconfigFindByClusterId) | **Get** /clusters/{clusterId}/kubeconfig | Read the Kubeconfig | +| DataPlatformClusterApi | [**ClustersPatch**](docs/api/DataPlatformClusterApi.md#ClustersPatch) | **Patch** /clusters/{clusterId} | Partially Modify a DataPlatformCluster | +| DataPlatformClusterApi | [**ClustersPost**](docs/api/DataPlatformClusterApi.md#ClustersPost) | **Post** /clusters | Create a DataPlatformCluster | +| DataPlatformMetaDataApi | [**VersionsGet**](docs/api/DataPlatformMetaDataApi.md#VersionsGet) | **Get** /versions | Managed Stackable Data Platform API Versions | +| DataPlatformNodePoolApi | [**ClustersNodepoolsDelete**](docs/api/DataPlatformNodePoolApi.md#ClustersNodepoolsDelete) | **Delete** /clusters/{clusterId}/nodepools/{nodepoolId} | Remove a DataPlatformNodePool from a DataPlatformCluster | +| DataPlatformNodePoolApi | [**ClustersNodepoolsFindById**](docs/api/DataPlatformNodePoolApi.md#ClustersNodepoolsFindById) | **Get** /clusters/{clusterId}/nodepools/{nodepoolId} | Retrieve a DataPlatformNodePool | +| DataPlatformNodePoolApi | [**ClustersNodepoolsGet**](docs/api/DataPlatformNodePoolApi.md#ClustersNodepoolsGet) | **Get** /clusters/{clusterId}/nodepools | List the DataPlatformNodePools of a DataPlatformCluster | +| DataPlatformNodePoolApi | [**ClustersNodepoolsPatch**](docs/api/DataPlatformNodePoolApi.md#ClustersNodepoolsPatch) | **Patch** /clusters/{clusterId}/nodepools/{nodepoolId} | Partially Modify a DataPlatformNodePool | +| DataPlatformNodePoolApi | [**ClustersNodepoolsPost**](docs/api/DataPlatformNodePoolApi.md#ClustersNodepoolsPost) | **Post** /clusters/{clusterId}/nodepools | Create a DataPlatformNodePool for a distinct DataPlatformCluster | + +
+## Documentation For Models +All URIs are relative to *https://api.ionos.com/dataplatform* +
+API models list + + - [AutoScaling](docs/models/AutoScaling) + - [AutoScalingBase](docs/models/AutoScalingBase) + - [AvailabilityZone](docs/models/AvailabilityZone) + - [Cluster](docs/models/Cluster) + - [ClusterListResponseData](docs/models/ClusterListResponseData) + - [ClusterResponseData](docs/models/ClusterResponseData) + - [CreateClusterProperties](docs/models/CreateClusterProperties) + - [CreateClusterRequest](docs/models/CreateClusterRequest) + - [CreateNodePoolProperties](docs/models/CreateNodePoolProperties) + - [CreateNodePoolRequest](docs/models/CreateNodePoolRequest) + - [ErrorMessage](docs/models/ErrorMessage) + - [ErrorResponse](docs/models/ErrorResponse) + - [Lan](docs/models/Lan) + - [MaintenanceWindow](docs/models/MaintenanceWindow) + - [Metadata](docs/models/Metadata) + - [NodePool](docs/models/NodePool) + - [NodePoolListResponseData](docs/models/NodePoolListResponseData) + - [NodePoolResponseData](docs/models/NodePoolResponseData) + - [PatchClusterProperties](docs/models/PatchClusterProperties) + - [PatchClusterRequest](docs/models/PatchClusterRequest) + - [PatchNodePoolProperties](docs/models/PatchNodePoolProperties) + - [PatchNodePoolRequest](docs/models/PatchNodePoolRequest) + - [Route](docs/models/Route) + - [StorageType](docs/models/StorageType) + - [VersionsGet200Response](docs/models/VersionsGet200Response) + + +[[Back to API list]](#documentation-for-api-endpoints) [[Back to Model list]](#documentation-for-models) + +
diff --git a/api_data_platform_cluster.go b/api_data_platform_cluster.go index 9925888..60f92a3 100644 --- a/api_data_platform_cluster.go +++ b/api_data_platform_cluster.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/api_data_platform_meta_data.go b/api_data_platform_meta_data.go index f855231..f0ad944 100644 --- a/api_data_platform_meta_data.go +++ b/api_data_platform_meta_data.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/api_data_platform_node_pool.go b/api_data_platform_node_pool.go index d02eb5d..293d3a6 100644 --- a/api_data_platform_node_pool.go +++ b/api_data_platform_node_pool.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/client.go b/client.go index 371d19b..ed9eba6 100644 --- a/client.go +++ b/client.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -50,10 +50,10 @@ const ( RequestStatusFailed = "FAILED" RequestStatusDone = "DONE" - Version = "1.1.0" + Version = "1.1.1" ) -// APIClient manages communication with the IONOS Cloud - Managed Stackable Data Platform API API v1.1.0 +// APIClient manages communication with the IONOS Cloud - Managed Stackable Data Platform API API v1.2.0 // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration diff --git a/configuration.go b/configuration.go index c330e83..1eeed58 100644 --- a/configuration.go +++ b/configuration.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -28,7 +28,7 @@ const ( IonosPinnedCertEnvVar = "IONOS_PINNED_CERT" IonosLogLevelEnvVar = "IONOS_LOG_LEVEL" DefaultIonosServerUrl = "https://api.ionos.com/dataplatform" - DefaultIonosBasePath = "" + DefaultIonosBasePath = "/dataplatform" defaultMaxRetries = 3 defaultWaitTime = time.Duration(100) * time.Millisecond defaultMaxWaitTime = time.Duration(2000) * time.Millisecond @@ -134,7 +134,7 @@ func NewConfiguration(username, password, token, hostUrl string) *Configuration cfg := &Configuration{ DefaultHeader: make(map[string]string), DefaultQueryParams: url.Values{}, - UserAgent: "ionos-cloud-sdk-go-dataplatform/v1.1.0", + UserAgent: "ionos-cloud-sdk-go-dataplatform/v1.1.1", Debug: false, Username: username, Password: password, diff --git a/docs/models/AutoScaling.md b/docs/models/AutoScaling.md new file mode 100644 index 0000000..ebfe56e --- /dev/null +++ b/docs/models/AutoScaling.md @@ -0,0 +1,69 @@ +# AutoScaling + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**MinNodeCount** | **int32** | The minimum number of nodes in a Node Pool | | +|**MaxNodeCount** | **int32** | The maximum number of nodes in a Node Pool | | + +## Methods + +### NewAutoScaling + +`func NewAutoScaling(minNodeCount int32, maxNodeCount int32, ) *AutoScaling` + +NewAutoScaling instantiates a new AutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAutoScalingWithDefaults + +`func NewAutoScalingWithDefaults() *AutoScaling` + +NewAutoScalingWithDefaults instantiates a new AutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMinNodeCount + +`func (o *AutoScaling) GetMinNodeCount() int32` + +GetMinNodeCount returns the MinNodeCount field if non-nil, zero value otherwise. + +### GetMinNodeCountOk + +`func (o *AutoScaling) GetMinNodeCountOk() (*int32, bool)` + +GetMinNodeCountOk returns a tuple with the MinNodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNodeCount + +`func (o *AutoScaling) SetMinNodeCount(v int32)` + +SetMinNodeCount sets MinNodeCount field to given value. + + +### GetMaxNodeCount + +`func (o *AutoScaling) GetMaxNodeCount() int32` + +GetMaxNodeCount returns the MaxNodeCount field if non-nil, zero value otherwise. + +### GetMaxNodeCountOk + +`func (o *AutoScaling) GetMaxNodeCountOk() (*int32, bool)` + +GetMaxNodeCountOk returns a tuple with the MaxNodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxNodeCount + +`func (o *AutoScaling) SetMaxNodeCount(v int32)` + +SetMaxNodeCount sets MaxNodeCount field to given value. + + + diff --git a/docs/models/AutoScalingBase.md b/docs/models/AutoScalingBase.md new file mode 100644 index 0000000..b81daa1 --- /dev/null +++ b/docs/models/AutoScalingBase.md @@ -0,0 +1,69 @@ +# AutoScalingBase + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +|**MinNodeCount** | **int32** | The minimum number of nodes in a Node Pool | | +|**MaxNodeCount** | **int32** | The maximum number of nodes in a Node Pool | | + +## Methods + +### NewAutoScalingBase + +`func NewAutoScalingBase(minNodeCount int32, maxNodeCount int32, ) *AutoScalingBase` + +NewAutoScalingBase instantiates a new AutoScalingBase object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAutoScalingBaseWithDefaults + +`func NewAutoScalingBaseWithDefaults() *AutoScalingBase` + +NewAutoScalingBaseWithDefaults instantiates a new AutoScalingBase object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMinNodeCount + +`func (o *AutoScalingBase) GetMinNodeCount() int32` + +GetMinNodeCount returns the MinNodeCount field if non-nil, zero value otherwise. + +### GetMinNodeCountOk + +`func (o *AutoScalingBase) GetMinNodeCountOk() (*int32, bool)` + +GetMinNodeCountOk returns a tuple with the MinNodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNodeCount + +`func (o *AutoScalingBase) SetMinNodeCount(v int32)` + +SetMinNodeCount sets MinNodeCount field to given value. + + +### GetMaxNodeCount + +`func (o *AutoScalingBase) GetMaxNodeCount() int32` + +GetMaxNodeCount returns the MaxNodeCount field if non-nil, zero value otherwise. + +### GetMaxNodeCountOk + +`func (o *AutoScalingBase) GetMaxNodeCountOk() (*int32, bool)` + +GetMaxNodeCountOk returns a tuple with the MaxNodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxNodeCount + +`func (o *AutoScalingBase) SetMaxNodeCount(v int32)` + +SetMaxNodeCount sets MaxNodeCount field to given value. + + + diff --git a/docs/models/CreateNodePoolProperties.md b/docs/models/CreateNodePoolProperties.md index 4669d7c..6531e73 100644 --- a/docs/models/CreateNodePoolProperties.md +++ b/docs/models/CreateNodePoolProperties.md @@ -15,6 +15,7 @@ |**MaintenanceWindow** | Pointer to [**MaintenanceWindow**](MaintenanceWindow.md) | | [optional] | |**Labels** | Pointer to **map[string]interface{}** | Key-value pairs attached to the node pool resource as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). | [optional] | |**Annotations** | Pointer to **map[string]interface{}** | Key-value pairs attached to node pool resource as [Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/). | [optional] | +|**AutoScaling** | Pointer to [**AutoScaling**](AutoScaling.md) | | [optional] | ## Methods @@ -300,4 +301,29 @@ SetAnnotations sets Annotations field to given value. HasAnnotations returns a boolean if a field has been set. +### GetAutoScaling + +`func (o *CreateNodePoolProperties) GetAutoScaling() AutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *CreateNodePoolProperties) GetAutoScalingOk() (*AutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *CreateNodePoolProperties) SetAutoScaling(v AutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *CreateNodePoolProperties) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + diff --git a/docs/models/NodePool.md b/docs/models/NodePool.md index a5b9b4e..c862f68 100644 --- a/docs/models/NodePool.md +++ b/docs/models/NodePool.md @@ -17,6 +17,7 @@ |**MaintenanceWindow** | Pointer to [**MaintenanceWindow**](MaintenanceWindow.md) | | [optional] | |**Labels** | Pointer to **map[string]interface{}** | Key-value pairs attached to the node pool resource as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). | [optional] | |**Annotations** | Pointer to **map[string]interface{}** | Key-value pairs attached to node pool resource as [Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/). | [optional] | +|**AutoScaling** | Pointer to [**AutoScaling**](AutoScaling.md) | | [optional] | ## Methods @@ -362,4 +363,29 @@ SetAnnotations sets Annotations field to given value. HasAnnotations returns a boolean if a field has been set. +### GetAutoScaling + +`func (o *NodePool) GetAutoScaling() AutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *NodePool) GetAutoScalingOk() (*AutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *NodePool) SetAutoScaling(v AutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *NodePool) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + diff --git a/docs/models/PatchNodePoolProperties.md b/docs/models/PatchNodePoolProperties.md index b2aa291..0024f66 100644 --- a/docs/models/PatchNodePoolProperties.md +++ b/docs/models/PatchNodePoolProperties.md @@ -8,6 +8,7 @@ |**MaintenanceWindow** | Pointer to [**MaintenanceWindow**](MaintenanceWindow.md) | | [optional] | |**Labels** | Pointer to **map[string]interface{}** | Key-value pairs attached to the node pool resource as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). | [optional] | |**Annotations** | Pointer to **map[string]interface{}** | Key-value pairs attached to node pool resource as [Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/). | [optional] | +|**AutoScaling** | Pointer to [**NullableAutoScaling**](AutoScaling.md) | | [optional] | ## Methods @@ -128,4 +129,39 @@ SetAnnotations sets Annotations field to given value. HasAnnotations returns a boolean if a field has been set. +### GetAutoScaling + +`func (o *PatchNodePoolProperties) GetAutoScaling() AutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *PatchNodePoolProperties) GetAutoScalingOk() (*AutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *PatchNodePoolProperties) SetAutoScaling(v AutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *PatchNodePoolProperties) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### SetAutoScalingNil + +`func (o *PatchNodePoolProperties) SetAutoScalingNil(b bool)` + + SetAutoScalingNil sets the value for AutoScaling to be an explicit nil + +### UnsetAutoScaling +`func (o *PatchNodePoolProperties) UnsetAutoScaling()` + +UnsetAutoScaling ensures that no value is present for AutoScaling, not even an explicit nil diff --git a/docs/summary.md b/docs/summary.md index 76289db..d4b0c32 100644 --- a/docs/summary.md +++ b/docs/summary.md @@ -11,6 +11,8 @@ ## Models +* [AutoScaling](models/AutoScaling.md) +* [AutoScalingBase](models/AutoScalingBase.md) * [AvailabilityZone](models/AvailabilityZone.md) * [Cluster](models/Cluster.md) * [ClusterListResponseData](models/ClusterListResponseData.md) diff --git a/logger.go b/logger.go index b914a90..03f8bdb 100644 --- a/logger.go +++ b/logger.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_auto_scaling.go b/model_auto_scaling.go new file mode 100644 index 0000000..8cd0b73 --- /dev/null +++ b/model_auto_scaling.go @@ -0,0 +1,169 @@ +/* + * IONOS Cloud - Managed Stackable Data Platform API + * + * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References + * + * API version: 1.2.0 + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package ionoscloud + +import ( + "encoding/json" +) + +// AutoScaling struct for AutoScaling +type AutoScaling struct { + // The minimum number of nodes in a Node Pool + MinNodeCount *int32 `json:"minNodeCount"` + // The maximum number of nodes in a Node Pool + MaxNodeCount *int32 `json:"maxNodeCount"` +} + +// NewAutoScaling instantiates a new AutoScaling object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAutoScaling(minNodeCount int32, maxNodeCount int32) *AutoScaling { + this := AutoScaling{} + + this.MinNodeCount = &minNodeCount + this.MaxNodeCount = &maxNodeCount + + return &this +} + +// NewAutoScalingWithDefaults instantiates a new AutoScaling object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAutoScalingWithDefaults() *AutoScaling { + this := AutoScaling{} + return &this +} + +// GetMinNodeCount returns the MinNodeCount field value +// If the value is explicit nil, the zero value for int32 will be returned +func (o *AutoScaling) GetMinNodeCount() *int32 { + if o == nil { + return nil + } + + return o.MinNodeCount + +} + +// GetMinNodeCountOk returns a tuple with the MinNodeCount field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AutoScaling) GetMinNodeCountOk() (*int32, bool) { + if o == nil { + return nil, false + } + + return o.MinNodeCount, true +} + +// SetMinNodeCount sets field value +func (o *AutoScaling) SetMinNodeCount(v int32) { + + o.MinNodeCount = &v + +} + +// HasMinNodeCount returns a boolean if a field has been set. +func (o *AutoScaling) HasMinNodeCount() bool { + if o != nil && o.MinNodeCount != nil { + return true + } + + return false +} + +// GetMaxNodeCount returns the MaxNodeCount field value +// If the value is explicit nil, the zero value for int32 will be returned +func (o *AutoScaling) GetMaxNodeCount() *int32 { + if o == nil { + return nil + } + + return o.MaxNodeCount + +} + +// GetMaxNodeCountOk returns a tuple with the MaxNodeCount field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AutoScaling) GetMaxNodeCountOk() (*int32, bool) { + if o == nil { + return nil, false + } + + return o.MaxNodeCount, true +} + +// SetMaxNodeCount sets field value +func (o *AutoScaling) SetMaxNodeCount(v int32) { + + o.MaxNodeCount = &v + +} + +// HasMaxNodeCount returns a boolean if a field has been set. +func (o *AutoScaling) HasMaxNodeCount() bool { + if o != nil && o.MaxNodeCount != nil { + return true + } + + return false +} + +func (o AutoScaling) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.MinNodeCount != nil { + toSerialize["minNodeCount"] = o.MinNodeCount + } + + if o.MaxNodeCount != nil { + toSerialize["maxNodeCount"] = o.MaxNodeCount + } + + return json.Marshal(toSerialize) +} + +type NullableAutoScaling struct { + value *AutoScaling + isSet bool +} + +func (v NullableAutoScaling) Get() *AutoScaling { + return v.value +} + +func (v *NullableAutoScaling) Set(val *AutoScaling) { + v.value = val + v.isSet = true +} + +func (v NullableAutoScaling) IsSet() bool { + return v.isSet +} + +func (v *NullableAutoScaling) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAutoScaling(val *AutoScaling) *NullableAutoScaling { + return &NullableAutoScaling{value: val, isSet: true} +} + +func (v NullableAutoScaling) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAutoScaling) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/model_auto_scaling_base.go b/model_auto_scaling_base.go new file mode 100644 index 0000000..df8f5b9 --- /dev/null +++ b/model_auto_scaling_base.go @@ -0,0 +1,169 @@ +/* + * IONOS Cloud - Managed Stackable Data Platform API + * + * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References + * + * API version: 1.2.0 + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package ionoscloud + +import ( + "encoding/json" +) + +// AutoScalingBase Auto scaling configuration for the Node Pool +type AutoScalingBase struct { + // The minimum number of nodes in a Node Pool + MinNodeCount *int32 `json:"minNodeCount"` + // The maximum number of nodes in a Node Pool + MaxNodeCount *int32 `json:"maxNodeCount"` +} + +// NewAutoScalingBase instantiates a new AutoScalingBase object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAutoScalingBase(minNodeCount int32, maxNodeCount int32) *AutoScalingBase { + this := AutoScalingBase{} + + this.MinNodeCount = &minNodeCount + this.MaxNodeCount = &maxNodeCount + + return &this +} + +// NewAutoScalingBaseWithDefaults instantiates a new AutoScalingBase object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAutoScalingBaseWithDefaults() *AutoScalingBase { + this := AutoScalingBase{} + return &this +} + +// GetMinNodeCount returns the MinNodeCount field value +// If the value is explicit nil, the zero value for int32 will be returned +func (o *AutoScalingBase) GetMinNodeCount() *int32 { + if o == nil { + return nil + } + + return o.MinNodeCount + +} + +// GetMinNodeCountOk returns a tuple with the MinNodeCount field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AutoScalingBase) GetMinNodeCountOk() (*int32, bool) { + if o == nil { + return nil, false + } + + return o.MinNodeCount, true +} + +// SetMinNodeCount sets field value +func (o *AutoScalingBase) SetMinNodeCount(v int32) { + + o.MinNodeCount = &v + +} + +// HasMinNodeCount returns a boolean if a field has been set. +func (o *AutoScalingBase) HasMinNodeCount() bool { + if o != nil && o.MinNodeCount != nil { + return true + } + + return false +} + +// GetMaxNodeCount returns the MaxNodeCount field value +// If the value is explicit nil, the zero value for int32 will be returned +func (o *AutoScalingBase) GetMaxNodeCount() *int32 { + if o == nil { + return nil + } + + return o.MaxNodeCount + +} + +// GetMaxNodeCountOk returns a tuple with the MaxNodeCount field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AutoScalingBase) GetMaxNodeCountOk() (*int32, bool) { + if o == nil { + return nil, false + } + + return o.MaxNodeCount, true +} + +// SetMaxNodeCount sets field value +func (o *AutoScalingBase) SetMaxNodeCount(v int32) { + + o.MaxNodeCount = &v + +} + +// HasMaxNodeCount returns a boolean if a field has been set. +func (o *AutoScalingBase) HasMaxNodeCount() bool { + if o != nil && o.MaxNodeCount != nil { + return true + } + + return false +} + +func (o AutoScalingBase) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.MinNodeCount != nil { + toSerialize["minNodeCount"] = o.MinNodeCount + } + + if o.MaxNodeCount != nil { + toSerialize["maxNodeCount"] = o.MaxNodeCount + } + + return json.Marshal(toSerialize) +} + +type NullableAutoScalingBase struct { + value *AutoScalingBase + isSet bool +} + +func (v NullableAutoScalingBase) Get() *AutoScalingBase { + return v.value +} + +func (v *NullableAutoScalingBase) Set(val *AutoScalingBase) { + v.value = val + v.isSet = true +} + +func (v NullableAutoScalingBase) IsSet() bool { + return v.isSet +} + +func (v *NullableAutoScalingBase) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAutoScalingBase(val *AutoScalingBase) *NullableAutoScalingBase { + return &NullableAutoScalingBase{value: val, isSet: true} +} + +func (v NullableAutoScalingBase) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAutoScalingBase) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/model_availability_zone.go b/model_availability_zone.go index 46a8179..cb70ac3 100644 --- a/model_availability_zone.go +++ b/model_availability_zone.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_cluster.go b/model_cluster.go index d7a3f65..1dc98b2 100644 --- a/model_cluster.go +++ b/model_cluster.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_cluster_list_response_data.go b/model_cluster_list_response_data.go index a74e016..7138cb7 100644 --- a/model_cluster_list_response_data.go +++ b/model_cluster_list_response_data.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_cluster_response_data.go b/model_cluster_response_data.go index 887b047..8b3cc06 100644 --- a/model_cluster_response_data.go +++ b/model_cluster_response_data.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_create_cluster_properties.go b/model_create_cluster_properties.go index 2cc6a5d..2079bc2 100644 --- a/model_create_cluster_properties.go +++ b/model_create_cluster_properties.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_create_cluster_request.go b/model_create_cluster_request.go index 7bd46e7..bffd308 100644 --- a/model_create_cluster_request.go +++ b/model_create_cluster_request.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_create_node_pool_properties.go b/model_create_node_pool_properties.go index c79ac84..e580fda 100644 --- a/model_create_node_pool_properties.go +++ b/model_create_node_pool_properties.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -35,6 +35,7 @@ type CreateNodePoolProperties struct { Labels *map[string]interface{} `json:"labels,omitempty"` // Key-value pairs attached to node pool resource as [Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/). Annotations *map[string]interface{} `json:"annotations,omitempty"` + AutoScaling *AutoScaling `json:"autoScaling,omitempty"` } // NewCreateNodePoolProperties instantiates a new CreateNodePoolProperties object @@ -500,6 +501,44 @@ func (o *CreateNodePoolProperties) HasAnnotations() bool { return false } +// GetAutoScaling returns the AutoScaling field value +// If the value is explicit nil, the zero value for AutoScaling will be returned +func (o *CreateNodePoolProperties) GetAutoScaling() *AutoScaling { + if o == nil { + return nil + } + + return o.AutoScaling + +} + +// GetAutoScalingOk returns a tuple with the AutoScaling field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *CreateNodePoolProperties) GetAutoScalingOk() (*AutoScaling, bool) { + if o == nil { + return nil, false + } + + return o.AutoScaling, true +} + +// SetAutoScaling sets field value +func (o *CreateNodePoolProperties) SetAutoScaling(v AutoScaling) { + + o.AutoScaling = &v + +} + +// HasAutoScaling returns a boolean if a field has been set. +func (o *CreateNodePoolProperties) HasAutoScaling() bool { + if o != nil && o.AutoScaling != nil { + return true + } + + return false +} + func (o CreateNodePoolProperties) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.Name != nil { @@ -546,6 +585,10 @@ func (o CreateNodePoolProperties) MarshalJSON() ([]byte, error) { toSerialize["annotations"] = o.Annotations } + if o.AutoScaling != nil { + toSerialize["autoScaling"] = o.AutoScaling + } + return json.Marshal(toSerialize) } diff --git a/model_create_node_pool_request.go b/model_create_node_pool_request.go index 9d8b452..caf9474 100644 --- a/model_create_node_pool_request.go +++ b/model_create_node_pool_request.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_error_message.go b/model_error_message.go index 03305d7..8a5509b 100644 --- a/model_error_message.go +++ b/model_error_message.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_error_response.go b/model_error_response.go index 2157c74..6519ee0 100644 --- a/model_error_response.go +++ b/model_error_response.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_lan.go b/model_lan.go index f21dc9b..74e5108 100644 --- a/model_lan.go +++ b/model_lan.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_maintenance_window.go b/model_maintenance_window.go index b5136d6..13bc8cd 100644 --- a/model_maintenance_window.go +++ b/model_maintenance_window.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_metadata.go b/model_metadata.go index 2f4ef46..22501e8 100644 --- a/model_metadata.go +++ b/model_metadata.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_node_pool.go b/model_node_pool.go index d721365..0d722a2 100644 --- a/model_node_pool.go +++ b/model_node_pool.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -39,6 +39,7 @@ type NodePool struct { Labels *map[string]interface{} `json:"labels,omitempty"` // Key-value pairs attached to node pool resource as [Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/). Annotations *map[string]interface{} `json:"annotations,omitempty"` + AutoScaling *AutoScaling `json:"autoScaling,omitempty"` } // NewNodePool instantiates a new NodePool object @@ -578,6 +579,44 @@ func (o *NodePool) HasAnnotations() bool { return false } +// GetAutoScaling returns the AutoScaling field value +// If the value is explicit nil, the zero value for AutoScaling will be returned +func (o *NodePool) GetAutoScaling() *AutoScaling { + if o == nil { + return nil + } + + return o.AutoScaling + +} + +// GetAutoScalingOk returns a tuple with the AutoScaling field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *NodePool) GetAutoScalingOk() (*AutoScaling, bool) { + if o == nil { + return nil, false + } + + return o.AutoScaling, true +} + +// SetAutoScaling sets field value +func (o *NodePool) SetAutoScaling(v AutoScaling) { + + o.AutoScaling = &v + +} + +// HasAutoScaling returns a boolean if a field has been set. +func (o *NodePool) HasAutoScaling() bool { + if o != nil && o.AutoScaling != nil { + return true + } + + return false +} + func (o NodePool) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.Name != nil { @@ -632,6 +671,10 @@ func (o NodePool) MarshalJSON() ([]byte, error) { toSerialize["annotations"] = o.Annotations } + if o.AutoScaling != nil { + toSerialize["autoScaling"] = o.AutoScaling + } + return json.Marshal(toSerialize) } diff --git a/model_node_pool_list_response_data.go b/model_node_pool_list_response_data.go index 4184c7a..5e069d9 100644 --- a/model_node_pool_list_response_data.go +++ b/model_node_pool_list_response_data.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_node_pool_response_data.go b/model_node_pool_response_data.go index d2f2941..05d8273 100644 --- a/model_node_pool_response_data.go +++ b/model_node_pool_response_data.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_patch_cluster_properties.go b/model_patch_cluster_properties.go index af19831..5a48b20 100644 --- a/model_patch_cluster_properties.go +++ b/model_patch_cluster_properties.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_patch_cluster_request.go b/model_patch_cluster_request.go index 27032b6..388fbce 100644 --- a/model_patch_cluster_request.go +++ b/model_patch_cluster_request.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_patch_node_pool_properties.go b/model_patch_node_pool_properties.go index b257952..df4f182 100644 --- a/model_patch_node_pool_properties.go +++ b/model_patch_node_pool_properties.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,6 +23,7 @@ type PatchNodePoolProperties struct { Labels *map[string]interface{} `json:"labels,omitempty"` // Key-value pairs attached to node pool resource as [Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/). Annotations *map[string]interface{} `json:"annotations,omitempty"` + AutoScaling *AutoScaling `json:"autoScaling,omitempty"` } // NewPatchNodePoolProperties instantiates a new PatchNodePoolProperties object @@ -195,6 +196,44 @@ func (o *PatchNodePoolProperties) HasAnnotations() bool { return false } +// GetAutoScaling returns the AutoScaling field value +// If the value is explicit nil, the zero value for AutoScaling will be returned +func (o *PatchNodePoolProperties) GetAutoScaling() *AutoScaling { + if o == nil { + return nil + } + + return o.AutoScaling + +} + +// GetAutoScalingOk returns a tuple with the AutoScaling field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *PatchNodePoolProperties) GetAutoScalingOk() (*AutoScaling, bool) { + if o == nil { + return nil, false + } + + return o.AutoScaling, true +} + +// SetAutoScaling sets field value +func (o *PatchNodePoolProperties) SetAutoScaling(v AutoScaling) { + + o.AutoScaling = &v + +} + +// HasAutoScaling returns a boolean if a field has been set. +func (o *PatchNodePoolProperties) HasAutoScaling() bool { + if o != nil && o.AutoScaling != nil { + return true + } + + return false +} + func (o PatchNodePoolProperties) MarshalJSON() ([]byte, error) { toSerialize := map[string]interface{}{} if o.NodeCount != nil { @@ -213,6 +252,8 @@ func (o PatchNodePoolProperties) MarshalJSON() ([]byte, error) { toSerialize["annotations"] = o.Annotations } + toSerialize["autoScaling"] = o.AutoScaling + return json.Marshal(toSerialize) } diff --git a/model_patch_node_pool_request.go b/model_patch_node_pool_request.go index 9fb1f7b..1b97eb2 100644 --- a/model_patch_node_pool_request.go +++ b/model_patch_node_pool_request.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_route.go b/model_route.go index e801b50..9a0d050 100644 --- a/model_route.go +++ b/model_route.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_storage_type.go b/model_storage_type.go index 2735987..a377f3d 100644 --- a/model_storage_type.go +++ b/model_storage_type.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/model_versions_get_200_response.go b/model_versions_get_200_response.go index d79b7d5..b6f9eea 100644 --- a/model_versions_get_200_response.go +++ b/model_versions_get_200_response.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/response.go b/response.go index a2de7c8..dd11fbb 100644 --- a/response.go +++ b/response.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/utils.go b/utils.go index c2d2d2d..92d2d39 100644 --- a/utils.go +++ b/utils.go @@ -3,7 +3,7 @@ * * *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References * - * API version: 1.1.0 + * API version: 1.2.0 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.