Release (2024-02-27)

Highlights

• core: v0.10.0
  • Feature: Add package runtime, which implements methods to be used when performing API requests.
  • Feature: Add method WithCaptureHTTPResponse to package runtime, which does the same as config.WithCaptureHTTPResponse. Method was moved to avoid confusion due to it not being a configuration option, and will be removed in a later release.
  • Feature: Add configuration option that, for the key flow, enables a goroutine to be spawned that will refresh the access token when it's close to expiring
  • Deprecation: Mark method config.WithCaptureHTTPResponse as deprecated, to avoid confusion due to it not being a configuration option. Use runtime.WithCaptureHTTPResponse instead.
  • Deprecation: Mark method config.WithJWKSEndpoint and field config.Configuration.JWKSCustomUrl as deprecated. Validation using JWKS was removed, for being redundant with token validation done in the APIs. These have no effect.
  • Deprecation:
    • Methods:
      • config.WithMaxRetries
      • config.WithWaitBetweenCalls
      • config.WithRetryTimeout
      • clients.NewRetryConfig
    • Fields:
      • clients.KeyFlowConfig.ClientRetry
      • clients.TokenFlowConfig.ClientRetry
      • clients.NoAuthFlowConfig.ClientRetry
      • clients.RetryConfig
    • Retry options removed to reduce complexity of the clients. If this functionality is needed, you can provide your own custom HTTP client.
  • Breaking Change: Change signature of auth.NoAuth, which no longer takes clients.RetryConfig as argument.
  • Breaking Change:
    • Methods:
      • clients.KeyFlow.Clone
      • clients.TokenFlow.Clone
      • clients.NoAuthFlow.Clone
      • clients.Do
    • Fields:
      • clients.DefaultRetryMaxRetries
      • clients.DefaultRetryWaitBetweenCalls
      • clients.DefaultRetryTimeout
    • Constants:
      • clients.ClientTimeoutErr
      • clients.ClientContextDeadlineErr
      • clients.ClientConnectionRefusedErr
      • clients.ClientEOFError
      • clients.Environment
    • Removed to reduce complexity of the clients, they were no longer being used.

What's Changed

• Replace membership example with authentication by @hcsa73 in #320
• Update module golang.org/x/oauth2 to v0.17.0 by @stackit-pipeline in #321
• Add LICENSE to root by @vicentepinto98 in #322
• Update GitHub actions by @joaopalet in #323
• Move WithCaptureHTTPResponse by @hcsa73 in #324
• Deprecate config.WithCaptureHTTPResponse by @hcsa73 in #325
• Update module github.com/stackitcloud/stackit-sdk-go/core to v0.8.0 by @stackit-pipeline in #326
• Remove token validation using JWKS in KeyFlow by @hcsa73 in #328
• Remove Key Flow unused methods by @hcsa73 in #327
• Undo removal of JWKSCustomUrl field by @hcsa73 in #330
• Remove golang.org/x/oauth2 core dependency by @joaopalet in #329
• Release 2024-02-19 by @hcsa73 in #331
• Update module github.com/stackitcloud/stackit-sdk-go/core to v0.9.0 by @stackit-pipeline in #332
• Add token refresh in background by @hcsa73 in #333
• Fix key flow bugs by @hcsa73 in #334
• Add example for background token refresh by @hcsa73 in #336
• Automatic tag helper script by @vicentepinto98 in #335
• Bump github.com/cloudflare/circl from 1.3.3 to 1.3.7 in /scripts by @dependabot in #338
• Update module golang.org/x/mod to v0.15.0 by @stackit-pipeline in #340
• Read password from terminal in automatic tag script by @vicentepinto98 in #339
• Remove backoff dependency and deprecate RetryOptions by @vicentepinto98 in #337
• Ask for confirmation in automatic script tags by @vicentepinto98 in #341

New Contributors

• @dependabot made their first contribution in #338

Full Changelog: release-2024-02-07...release-2024-02-27

Release (2024-02-07)

Warning

The membership module has been replaced with the authorization module, which connects to the same API.

This module will receive no further updates. Use github.com/stackitcloud/stackit-sdk-go/services/authorization instead.

Highlights

• authorization: v0.1.0
  • First release. This module offers the same functionalities as membership (as of v0.4.0).
• membership: v0.4.0
  • Add deprecation note

Release (2024-02-06)

Warning

The STACKIT PostgreSQL service will reach its end of support on June 30th 2024. All calls done to the API after that will stop working.

Use github.com/stackitcloud/stackit-sdk-go/services/postgresflex instead. For more details, check https://docs.stackit.cloud/stackit/en/bring-your-data-to-stackit-postgresql-flex-138347648.html.

Highlights

• postgresql: v0.12.0
  • Add deprecation note
• ske: v0.10.0
  • Feature: New endpoints for credentials rotation.
    • StartCredentialsRotation
    • CompleteCredentialsRotation
    • CreateKubeconfig
    • These endpoints replace GetCredentials and TriggerRotateCredentials, which are deprecated and will not work for clusters with Kubernetes v1.27+, or if the new endpoints for kubeconfig or credentials rotation have already been used. For more information, see How to rotate SKE credentials.

Release (2024-02-05)

Highlights

• logme: v0.10.0
  • Feature: Instance has a new field OfferingName
• mariadb: v0.10.0
  • Feature: Instance has a new field OfferingName
• opensearch: v0.10.0
  • Feature: Instance has a new field OfferingName
• postgresflex: v0.9.0
  • Feature: New API method UpdateUser to update user
  • Feature: New API method PartialUpdateUser to patch update user
  • Feature: New API method ResetUser to reset a user's password
• postgresql: v0.11.0
  • Feature: Instance has a new field OfferingName
• rabbitmq: v0.10.0
  • Feature: Instance has a new field OfferingName
• redis: v0.10.0
  • Feature: Instance has a new field OfferingName

Release (2024-01-24)

Highlights

• loadbalancer: v0.9.0
  • Feature: Server Name Indicator (SNI) support
  • Feature: Layer 4 Session Persistance

Release (2024-01-09)

Highlights

• core: v0.7.5
  • Improvement: When using the key flow, the SDK will extract the private key from the service account key and use it, if no private key is provided in the configuration, through environment variable or in the credentials file. This makes it simpler to use the key flow: if you create a service account key including the private key, you don't need to provide the private key separately anymore
• dns: v0.8.0
  • Feature: Zone has a new filed Labels, which is an array of labels (key-value pairs) associated to a zone
  • Feature: ListZones can be filtered by label keys or values
  • Feature: CloneZonePayload has a flag AdjustRecords to adjust the record set content of the cloned zone (replaces the dns name of the original zone with the new dns name of the cloned zone)
• logme: v0.9.0
  • Feature: PartialUpdateInstance can be used to update the instance's name
  • Feature: InstanceParameters has a new setting MaxDiskThreshold
  • Feature: ListMetricsResponse has new fields regarding ephemeral disk
• mariadb: v0.9.0
  • Feature: PartialUpdateInstance can be used to update the instance's name
  • Feature: InstanceParameters has a new setting MaxDiskThreshold
  • Feature: ListMetricsResponse has new fields regarding ephemeral disk
• mongodbflex: v0.10.0
  • Breaking Change: Added method ListMetrics (which accepts the desired metric: cpu, database, disk-iops, disk-use, or exec-time) as an argument and replaces ListCPUMetrics, ListDatabaseStorageMetrics, ListDiskIOPSMetrics, ListDiskUsageMetrics, and ListExecutionTimesMetrics, respectivelly
  • Breaking Change: Removes the previously deprecated method GetStorage, replaced by ListStorages
• opensearch: v0.9.0
  • Feature: PartialUpdateInstance can be used to update the instance's name
  • Feature: InstanceParameters has a new setting MaxDiskThreshold
  • Feature: ListMetricsResponse has new fields regarding ephemeral disk
• postgresql: v0.10.0
  • Feature: PartialUpdateInstance can be used to update the instance's name
  • Feature: InstanceParameters has a new setting MaxDiskThreshold
  • Feature: ListMetricsResponse has new fields regarding ephemeral disk
• rabbitmq: v0.9.0
  • Feature: PartialUpdateInstance can be used to update the instance's name
  • Feature: InstanceParameters has a new setting MaxDiskThreshold
  • Feature: ListMetricsResponse has new fields regarding ephemeral disk
• redis: v0.9.0
  • Feature: PartialUpdateInstance can be used to update the instance's name
  • Feature: InstanceParameters has a new setting MaxDiskThreshold
  • Feature: ListMetricsResponse has new fields regarding ephemeral disk
• ske: v0.9.0
  • Improvement: Add details on credentials for old clusters
  • Feature: ClusterStatus now has a field CredentialsRotation with credentials' details

Release (2023-12-22)

Highlights

• mongodbflex: v0.9.0
  • Added struct ApiListStoragesRequest, which will replace ApiGetStorageRequest
    • ApiGetStorageRequest has been marked as deprecated, and will be removed in the next minor update
  • Added method ListStorages, which will replace GetStorage
    • GetStorage has been marked as deprecated, and will be removed in the next minor update
  • Added CloneInstanceWaitHandler, to wait for CloneInstance async operation to be completed

Release (2023-12-20)

API methods, structs and waiters were renamed to have the same look and feel across all services and according to user feedback.
Most significant changes:

• Methods to get multiple instances of the same resource are now named List[Resource Name]
• Methods to fully update a resource are now named Update[Resource Name]
• Methods to update some fields of a resource are now named PartialUpdate[Resource Name]
• Methods relative to API service enablement are now named GetServiceStatus, EnableService and DisableService
• Several common terms, such as ACL and Credentials, have been standardized
• Structs only used in method responses are named [Method Name]Response
• Waiters for a given method are now named [Method name]WaitHandler

Highlights

Below is the list of changes for the API methods. For each service, you can check out the full changelog.

• argus: v0.8.0
  • CreateCredential renamed to CreateCredentials
  • CreateInstanceAlertConfigReceiver renamed to CreateAlertConfigReceiver
  • DeleteCredential renamed to DeleteCredentials
  • DeleteCredentialRemoteWriteConfig renamed to DeleteCredentialsRemoteWriteConfig
  • DeleteInstanceAlertConfigReceiver renamed to DeleteAlertConfigReceiver
  • DeleteInstanceAlertConfigRouteReceiver renamed to DeleteAlertConfigRoute
  • GetCredential renamed to GetCredentials
  • GetCredentialRemoteWriteConfig renamed to GetCredentialsRemoteWriteConfig
  • GetCredentials renamed to ListCredentials
  • GetInstanceAcl renamed to ListACL
  • GetInstanceAlertConfigReceiver renamed to GetAlertConfigReceiver
  • GetInstanceAlertConfigReceivers renamed to ListAlertConfigReceivers
  • GetInstanceAlertConfigRoutes renamed to ListAlertConfigRoute
  • GetInstanceAlertConfigs renamed to GetAlertConfigs
  • GetInstanceGrafanaConfigs renamed to GetGrafanaConfigs
  • GetInstances renamed to ListInstances
  • GetPlans renamed to ListPlans
  • GetScrapeConfigs renamed to ListScrapeConfigs
  • UpdateCredentialRemoteWriteConfig renamed to UpdateCredentialsRemoteWriteConfig
  • UpdateInstanceAcl renamed to UpdateACL
  • UpdateInstanceAlertConfigReceiver renamed to UpdateAlertConfigReceiver
  • UpdateInstanceAlertConfigRouteReceiver renamed to UpdateAlertConfigRoute
  • UpdateInstanceAlertConfigs renamed to UpdateAlertConfigs
  • UpdateInstanceGrafanaConfigs renamed to UpdateGrafanaConfigs
• dns: v0.7.0
  • GetRecordSets renamed to ListRecordSets
  • GetZones renamed to ListZones
  • UpdateRecord renamed to PartialUpdateRecord
  • UpdateRecordSet renamed to PartialUpdateRecordSet
  • UpdateZone renamed to PartialUpdateZone
• loadbalancer: v0.8.0
  • DisableLoadBalancing renamed to DisableService
  • EnableLoadBalancing renamed to EnableService
  • GetProjectStatus renamed to GetServiceStatus
• logme: v0.8.0
  • GetCredentialsIds renamed to ListCredentials
  • GetInstances renamed to ListInstances
  • GetOfferings renamed to ListOfferings
  • UpdateInstance renamed to PartialUpdateInstance
• mariadb: v0.8.0
  • GetCredentialsIds renamed to ListCredentials
  • GetInstances renamed to ListInstances
  • GetOfferings renamed to ListOfferings
  • UpdateInstance renamed to PartialUpdateInstance
• membership: v0.3.0
  • DeleteMembers renamed to RemoveMembers
  • GetMembers renamed to ListMembers
  • GetMemberships renamed to ListUserMemberships
  • GetPermissions renamed to ListPermissions
  • GetRoles renamed to ListRoles
  • UpdateMembers renamed to AddMembers
• mongodbflex: v0.8.0
  • DeleteProject renamed to DisableService
  • GetBackups renamed to ListBackups
  • GetCPUMetrics renamed to ListCPUMetrics
  • GetDatabaseStorageMetrics renamed to ListDatabaseStorageMetrics
  • GetDiskIOPSMetrics renamed to ListDiskIOPSMetrics
  • GetDiskUsageMetrics renamed to ListDiskUsageMetrics
  • GetExecutionTimesMetrics renamed to ListExecutionTimesMetrics
  • GetFlavors renamed to ListFlavors
  • GetInstanceRestores renamed to ListRestoreJobs
  • GetInstances renamed to ListInstances
  • GetMemoryMetrics renamed to ListMemoryMetrics
  • GetUsers renamed to ListUsers
• objectstorage: v0.8.0
  • CreateProject renamed to EnableService
  • DeleteProject renamed to DisableService
  • GetAccessKeys renamed to ListAccessKeys
  • GetBuckets renamed to ListBuckets
  • GetCredentialsGroups renamed to ListCredentialsGroups
  • GetProject renamed to GetServiceStatus
• opensearch: v0.8.0
  • GetCredentialsIds renamed to ListCredentials
  • GetInstances renamed to ListInstances
  • GetOfferings renamed to ListOfferings
  • UpdateInstance renamed to PartialUpdateInstance
• postgresflex: v0.8.0
  • GetBackups renamed to ListBackups
  • GetFlavors renamed to ListFlavors
  • GetInstances renamed to ListInstances
  • GetStorages renamed to ListStorages
  • GetUsers renamed to ListUsers
  • GetVersions renamed to ListVersions
  • UpdateInstance renamed to PartialUpdateInstance
• postgresql: v0.9.0
  • GetCredentialsIds renamed to ListCredentials
  • GetInstances renamed to ListInstances
  • GetOfferings renamed to ListOfferings
  • UpdateInstance renamed to PartialUpdateInstance
• rabbitmq: v0.8.0
  • GetCredentialsIds renamed to ListCredentials
  • GetInstances renamed to ListInstances
  • GetOfferings renamed to ListOfferings
  • UpdateInstance renamed to PartialUpdateInstance
• redis: v0.8.0
  • GetCredentialsIds renamed to ListCredentials
  • GetInstances renamed to ListInstances
  • GetOfferings renamed to ListOfferings
  • UpdateInstance renamed to PartialUpdateInstance
• resourcemanager: v0.7.0
  • GetProjects renamed to ListProjects
  • UpdateProject renamed to PartialUpdateProject
• secretsmanager: v0.5.0
  • CreateAcl renamed to CreateACL
  • DeleteAcl renamed to DeleteACL
  • GetAcl renamed to GetACL
  • GetAcls renamed to ListACLs
  • GetInstances renamed to ListInstances
  • UpdateAcl renamed to UpdateACL
• serviceaccount: v0.3.0
  • GetAccessTokens renamed to ListAccessTokens
  • GetServiceAccountJWKS renamed to GetJWKS
  • GetServiceAccountKeys renamed to ListServiceAccountKeys
  • GetServiceAccounts renamed to ListServiceAccounts
  • GetUsers renamed to ListUsers
  • UpdateServiceAccountKey renamed to PartialUpdateServiceAccountKey
• ske: v0.8.0
  • CreateProject renamed to EnableService
  • DeleteProject renamed to DisableService
  • GetClusters renamed to ListClusters
  • GetOptions renamed to ListProviderOptions
  • GetProject renamed to GetServiceStatus

Release (2023-12-18)

This is the first GitHub release of the STACKIT Go SDK.

Highlights

List of modules:

• core: v0.7.3
  • auth: setup authentication, specifically using the service account key or token flows. Check our authentication example
  • clients: baseline http client implementations to support different use cases, such as the different authentication flows
  • config: configuration for the SDK clients, such as custom endpoints, region and custom http client configuration. Check our configuration example
  • oapierror: open api error definition and handling
  • utils: utilities, such as the Ptr method to return a pointer to a variable of any type, which can be useful for creating payloads
  • wait: functionality to wait until a specific async operation has finished. Check our waiter example
• argus: v0.7.0
  • Manage your STACKIT Argus resources: Instance, Credentials, ScrapeConfig, Acl, Alertconfig, GrafanaConfig
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, CreateScrapeConfigWaitHandler, DeleteScrapeConfigWaitHandler
  • Usage example
• dns: v0.6.0
  • Manage your STACKIT DNS resources: Zones, RecordSet
  • Waiters for async operations: CreateZoneWaitHandler, UpdateZoneWaitHandler, DeleteZoneWaitHandler, CreateRecordSetWaitHandler, UpdateRecordSetWaitHandler, DeleteRecordSetWaitHandler
  • Usage example
• loadbalancer: v0.7.0
  • Manage your STACKIT Load Balancer resources: LoadBalancer, Credentials
  • Waiters for async operations: CreateLoadBalancerWaitHandler, DeleteLoadBalancerWaitHandler, EnableLoadBalancingWaitHandler
  • Usage example
• logme: v0.7.0
  • Manage your STACKIT Logme resources: Instance, Credentials, Offerings
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, CreateCredentialsWaitHandler, DeleteCredentialsWaitHandler
  • Usage example
• mariadb: v0.7.0
  • Manage your STACKIT MariaDB resources: Instance, Credentials, Offerings
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, CreateCredentialsWaitHandler, DeleteCredentialsWaitHandler
  • Usage example
• membership: v0.2.0
  • Manage membership of your STACKIT resources
  • Usage example
• mongodbflex: v0.7.0
  • Manage your STACKIT MongoDB Flex resources: Instance, Flavors, Metrics, User, Storages, Versions
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler
  • Usage example
• objectstorage: v0.7.0
  • Manage your STACKIT Object Storage resources: Bucket, AccessKey, CredentialGroup
  • Waiters for async operations: CreateBucketWaitHandler, DeleteBucketWaitHandler
  • Usage example
• opensearch: v0.7.0
  • Manage your STACKIT OpenSearch resources: Instance, Credentials, Offerings
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, CreateCredentialsWaitHandler, DeleteCredentialsWaitHandler
  • Usage example
• postgresflex: v0.7.0
  • Manage your STACKIT PostgreSQL Flex resources: Instance, Versions, Flavors, User, Storages
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, DeleteUserWaitHandler
  • Usage example
• postgresql: v0.8.0
  • Manage your STACKIT PostgreSQL resources: Instance, Credentials, Offerings
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, CreateCredentialsWaitHandler, DeleteCredentialsWaitHandler
  • Usage example
• rabbitmq: v0.7.0
  • Manage your STACKIT RabbitMQ resources: Instance, Credentials, Offerings
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, CreateCredentialsWaitHandler, DeleteCredentialsWaitHandler
  • Usage example
• redis: v0.7.0
  • Manage your STACKIT Redis resources: Instance, Credentials, Offerings
  • Waiters for async operations: CreateInstanceWaitHandler, UpdateInstanceWaitHandler, DeleteInstanceWaitHandler, CreateCredentialsWaitHandler, DeleteCredentialsWaitHandler
  • Usage example
• resourcemanager: v0.6.0
  • Manage your STACKIT projects
  • Waiters for async operations: CreateProjectWaitHandler, DeleteProjectWaitHandler
  • Usage example
• secretsmanager: v0.4.0
  • Manage your STACKIT Secrets Manager resources: Instance, Acl, User
  • Usage example
• serviceaccount: v0.2.0
  • Manage your STACKIT service accounts
  • Usage example
• ske: v0.7.0
  • Manage your STACKIT Kubernetes Engine resources: Project, Cluster, Credentials, Options
  • Waiters for async operations: CreateOrUpdateClusterWaitHandler, DeleteClusterWaitHandler, CreateProjectWaitHandler, DeleteProjectWaitHandler, RotateCredentialsWaitHandler
  • Usage example