Introduction
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.
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).
To get your DataPlatformCluster up and running, the following steps needs to be performed.
The first step is the creation of a IONOS Cloud account if not already existing.
The Managed Data Stack needs a virtual datacenter (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed DataPlatform to other services already running within your VDC. Otherwise, if you want to place the Managed Data Stack 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-CLI or the DCD Web interface. For more information, see the official documentation
To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS-CLI the following way:
ionosctl token generate
Before using Managed Stackable Data Platform, a new DataPlatformCluster must be created.
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 with the cluster ID that was presented to you in the response of the create cluster call.
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.
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.
The kubeconfig can be downloaded with the Get Kubeconfig endpoint using the cluster ID of the created DataPlatformCluster.
To create the desired application, the Stackable service needs to be provided, using the received kubeconfig and deploy a Stackable service
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.
The basic auth scheme uses the IONOS Cloud user credentials in form of a Basic Authentication Header accordingly to RFC7617
The Bearer auth token used at the API-Gateway is a user related token created with the IONOS-CLI. (See the documentation for details) For every request to be authenticated, the token is passed as 'Authorization Bearer' header along with the request.
Currently, an admin can see and manipulate all resources in a contract. A normal authenticated user can only see and manipulate resources he created.
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.
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 datacenter 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.
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 readonly in the customer's VDC and can only be modified or deleted via the API.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 0.0.7
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://ionos.com
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import sw "./ionoscloud"
To use a proxy, set the environment variable
HTTP_PROXY:os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Default configuration comes with
Servers field that contains server objects as defined in the OpenAPI specification.For using other server than the one defined on index 0 set context value
sw.ContextServerIndex of type int.ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated server URL is formatted using default variables from configuration or from context value
sw.ContextServerVariables of type map[string]string.ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
Each operation can use different server URL defined using
OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
All URIs are relative to https://api.ionos.com/dataplatform
Class | Method | HTTP request | Description |
|---|---|---|---|
DataPlatformClusterApi | Post /clusters | Create a DataPlatformCluster | |
DataPlatformClusterApi | Delete /clusters/{clusterId} | Delete DataPlatformCluster | |
DataPlatformClusterApi | Get /clusters/{clusterId} | Retrieve a DataPlatformCluster | |
DataPlatformClusterApi | Get /clusters/{clusterId}/kubeconfig | Read the kubeconfig | |
DataPlatformClusterApi | Get /clusters | List DataPlatformCluster | |
DataPlatformClusterApi | Patch /clusters/{clusterId} | Partially modify a DataPlatformCluster | |
DataPlatformMetaDataApi | Get /versions | Managed Data Stack API version | |
DataPlatformNodePoolApi | Post /clusters/{clusterId}/nodepools | Create a DataPlatformNodePool for a distinct DataPlatformCluster | |
DataPlatformNodePoolApi | Delete /clusters/{clusterId}/nodepools/{nodepoolId} | Remove node pool from DataPlatformCluster. | |
DataPlatformNodePoolApi | Get /clusters/{clusterId}/nodepools/{nodepoolId} | Retrieve a DataPlatformNodePool | |
DataPlatformNodePoolApi | Get /clusters/{clusterId}/nodepools | List the DataPlatformNodePools of a DataPlatformCluster | |
DataPlatformNodePoolApi | Patch /clusters/{clusterId}/nodepools/{nodepoolId} | Partially modify a DataPlatformNodePool |
- Type: HTTP basic authentication
Example
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
- Type: HTTP Bearer token authentication
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARERTOKENSTRING")
r, err := client.Service.Operation(auth, args)
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:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime
Last modified 9mo ago