Skip to content

ClusterOperatorAPI.md

Latest commit

 

History

History
366 lines (231 loc) · 10.9 KB

ClusterOperatorAPI.md

File metadata and controls

366 lines (231 loc) · 10.9 KB
Raw

\ClusterOperatorAPI

All URIs are relative to https://api.qovery.com

Method HTTP request Description
AttachClusterOperator Post /organization/{organizationId}/cluster/{clusterId}/operator/attach Attach a cluster to the Qovery Operator execution path
GetClusterOperatorBootstrap Get /organization/{organizationId}/cluster/{clusterId}/operator/bootstrap Get the Qovery Operator bootstrap
GetClusterOperatorStatus Get /organization/{organizationId}/cluster/{clusterId}/operator/status Get the Qovery Operator status for a cluster
ListClusterOperatorFleet Get /admin/operator/clusters List the Qovery Operator fleet
UpdateClusterOperator Post /organization/{organizationId}/cluster/{clusterId}/operator/update Update the Qovery Operator on a cluster

AttachClusterOperator

AttachClusterOperator(ctx, organizationId, clusterId).Execute()

Attach a cluster to the Qovery Operator execution path

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ClusterOperatorAPI.AttachClusterOperator(context.Background(), organizationId, clusterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClusterOperatorAPI.AttachClusterOperator``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string Organization ID
clusterId string Cluster ID

Other Parameters

Other parameters are passed through a pointer to a apiAttachClusterOperatorRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClusterOperatorBootstrap

ClusterOperatorBootstrapResponse GetClusterOperatorBootstrap(ctx, organizationId, clusterId).Execute()

Get the Qovery Operator bootstrap

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClusterOperatorAPI.GetClusterOperatorBootstrap(context.Background(), organizationId, clusterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClusterOperatorAPI.GetClusterOperatorBootstrap``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetClusterOperatorBootstrap`: ClusterOperatorBootstrapResponse
	fmt.Fprintf(os.Stdout, "Response from `ClusterOperatorAPI.GetClusterOperatorBootstrap`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string Organization ID
clusterId string Cluster ID

Other Parameters

Other parameters are passed through a pointer to a apiGetClusterOperatorBootstrapRequest struct via the builder pattern

Name Type Description Notes

Return type

ClusterOperatorBootstrapResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClusterOperatorStatus

ClusterOperatorStatusResponse GetClusterOperatorStatus(ctx, organizationId, clusterId).Execute()

Get the Qovery Operator status for a cluster

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClusterOperatorAPI.GetClusterOperatorStatus(context.Background(), organizationId, clusterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClusterOperatorAPI.GetClusterOperatorStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetClusterOperatorStatus`: ClusterOperatorStatusResponse
	fmt.Fprintf(os.Stdout, "Response from `ClusterOperatorAPI.GetClusterOperatorStatus`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string Organization ID
clusterId string Cluster ID

Other Parameters

Other parameters are passed through a pointer to a apiGetClusterOperatorStatusRequest struct via the builder pattern

Name Type Description Notes

Return type

ClusterOperatorStatusResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListClusterOperatorFleet

ClusterOperatorFleetInventoryResponseList ListClusterOperatorFleet(ctx).Execute()

List the Qovery Operator fleet

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClusterOperatorAPI.ListClusterOperatorFleet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClusterOperatorAPI.ListClusterOperatorFleet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListClusterOperatorFleet`: ClusterOperatorFleetInventoryResponseList
	fmt.Fprintf(os.Stdout, "Response from `ClusterOperatorAPI.ListClusterOperatorFleet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiListClusterOperatorFleetRequest struct via the builder pattern

Return type

ClusterOperatorFleetInventoryResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateClusterOperator

ClusterOperatorUpdateResponse UpdateClusterOperator(ctx, organizationId, clusterId).ClusterOperatorUpdateRequest(clusterOperatorUpdateRequest).Execute()

Update the Qovery Operator on a cluster

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID
	clusterOperatorUpdateRequest := *openapiclient.NewClusterOperatorUpdateRequest("0.2.2") // ClusterOperatorUpdateRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ClusterOperatorAPI.UpdateClusterOperator(context.Background(), organizationId, clusterId).ClusterOperatorUpdateRequest(clusterOperatorUpdateRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClusterOperatorAPI.UpdateClusterOperator``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateClusterOperator`: ClusterOperatorUpdateResponse
	fmt.Fprintf(os.Stdout, "Response from `ClusterOperatorAPI.UpdateClusterOperator`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string Organization ID
clusterId string Cluster ID

Other Parameters

Other parameters are passed through a pointer to a apiUpdateClusterOperatorRequest struct via the builder pattern

Name Type Description Notes

clusterOperatorUpdateRequest | ClusterOperatorUpdateRequest | |

Return type

ClusterOperatorUpdateResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]