Changelog

Summary

• Added Disaster Recovery (DR) support to various cluster and deployment schemas, including new properties for DR configuration.
• Introduced new permissions for alert, environment object, and notification channel endpoints.
• Updated Cluster schema with new status enum values and required properties for DR.
• Modified OrganizationProductPlan schema with changes to the astronomerProduct enum values.

Added

• Schemas and Properties:

  • Cluster:
    • drRegion: Secondary region for DR.
    • drSecondaryVpcCidr: Secondary CIDR for DR region (AWS only).
    • drVpcSubnetRange: VPC subnet range for DR region (AWS only).
    • enableReplicationTimeControl: Boolean for S3 Replication Time Control.
    • failoverInProgress: Boolean indicating if failover is in progress.
    • isDrEnabled: Boolean indicating if DR is enabled.
    • isFailedOver: Boolean indicating if the cluster is failed over to DR region.
    • secondaryVpcCidr: Secondary CIDR for pod networking.
  • CreateAlertRequest:
    • discriminator: Property type.
  • CreateAwsClusterRequest:
    • drRegion, drSecondaryVpcCidr, drVpcSubnetRange, enableReplicationTimeControl, secondaryVpcCidr.
  • CreateAzureClusterRequest:
    • drRegion, drVpcSubnetRange.
  • CreateClusterRequest:
    • discriminator: Property cloudProvider.
  • CreateDedicatedDeploymentRequest:
    • drWorkloadIdentity: DR workload identity.
  • CreateDeploymentRequest:
    • discriminator: Property type.
  • CreateGcpClusterRequest:
    • drRegion, drVpcSubnetRange.
  • CreateHybridDeploymentRequest:
    • drWorkloadIdentity.
  • CreateNotificationChannelRequest:
    • discriminator: Property type.
  • CreateStandardDeploymentRequest:
    • drWorkloadIdentity.
  • Deployment:
    • drExternalIPs: List of external IPs in DR cluster.
    • drOidcIssuerUrl: OIDC issuer URL for DR cluster.
    • drWorkloadIdentity.
  • UpdateAlertRequest:
    • discriminator: Property type.
  • UpdateClusterRequest:
    • discriminator: Property clusterType.
  • UpdateDedicatedClusterRequest:
    • enableDr: Boolean to enable/disable DR.
    • isFailedOver: Boolean to trigger DR failover.
  • UpdateDedicatedDeploymentRequest:
    • drWorkloadIdentity.
  • UpdateDeploymentRequest:
    • discriminator: Property type.
  • UpdateHybridDeploymentRequest:
    • drWorkloadIdentity.
  • UpdateNotificationChannelRequest:
    • discriminator: Property type.
  • UpdateStandardDeploymentRequest:
    • drWorkloadIdentity.

• Endpoints:

  • Added x-permission for alert, environment object, and notification channel endpoints.

• Enums:

  • Cluster.status: Added FAILING_OVER, FAILOVER_FAILED.
  • Organization.supportPlan: Added ENTERPRISE_BUSINESS_CRITICAL.
  • OrganizationProductPlan.astronomerProduct: Added OBSERVE.

Changed

• Schemas:
  • Cluster:
    • Removed description from vpcSubnetRange.
    • Added drRegion and isDrEnabled to required properties.
  • OrganizationProductPlan:
    • Changed astronomerProduct enum value from "ASTRO OBSERVE" to "ASTRO".

Summary

• Added a new pattern property to the ConnectionAuthTypeParameter schema, which specifies a regex pattern for the parameter.
• Introduced a new enum value SNOWFLAKE_MARKETPLACE to the paymentMethod property of the Organization schema.

Added

• ConnectionAuthTypeParameter Schema
  • pattern: A new property with a description “A regex pattern for the parameter” and type string.
• Organization Schema
  • paymentMethod Enum
    • SNOWFLAKE_MARKETPLACE: Added as a new payment method option.

Changed

• No changes were made to existing objects, schemas, fields, endpoints, or enum values.

Summary

• Added new properties apiUrl and uiUrl to the Deployment schema, providing URLs for accessing the Airflow API and UI respectively. For Airflow 2, the apiUrl and uiUrl point to the webserver. For Airflow 3 Deployments, these point to the API server.
• Updated the Deployment schema to require the apiUrl and uiUrl properties.

Added

• New properties in the Deployment schema:
  • apiUrl:
    • Description: The base URL to directly access the Airflow API.
  • uiUrl:
    • Description: The URL to access the Airflow UI.

Summary

• Added support for specifying authentication type when configuring metrics export settings for environments and environment objects.

Added

• New authType property added to the following schema objects to define the type of authentication used when connecting to a remote endpoint for metrics export from Astro:
  • EnvironmentObjectMetricsExport
  • EnvironmentObjectMetricsExportOverrides
  • CreateEnvironmentObjectMetricsExportRequest
  • UpdateEnvironmentObjectMetricsExportRequest
  • UpdateEnvironmentObjectMetricsExportOverridesRequest

Property Details

• authType: Defines the type of authentication to use when connecting to the remote endpoint.
  • Supported values:
    • BASIC
    • AUTH_TOKEN

Summary

• You can now create and update Airflow 3 Hosted Execution Deployments with the AstroExecutor via the Platform API.
• You can now create and update Airflow 3 Remote Execution Deployments with the AstroExecutor via the Platform API.
• Enable or disable Enhanced Support Access for your Organization API endpoints.

Added

• New properties to support creating and updating Remote Execution Deployments on Astro:
  • DeploymentRemoteExecution
  • DeploymentRemoteExecutionRequest
• New ENUMs for executor types were added to the executor property to support creating Hosted execution Deployments:
  • Astro
• Date-time and format examples for the following properties:
  • createdAt
  • updatedAt

Changed

• In /organizations/{organizationId}/alerts, removed the ORGANIZATION and WORKSPACE ENUMs that you can use to search within the entityType for the PatternMatchRequest object.

Summary

Added new enums for the supportPlan property. To learn more about the different support plans available for Astro, see Pricing.

Added

The new enums include the following:

• INACTIVE
• INTERNAL
• POV
• BASIC_PAYGO
• TEAM_PAYGO
• BUSINESS
• TEAM
• ENTERPRISE
• DEVELOPER
• DEVELOPER_PAYGO
• TEAM_V2
• BUSINESS_V2
• ENTERPRISE_V2
• TRIAL_V2

Summary

Added the PatternMatchRequest object, and changed the schema name of PatternMatch to PatternMatchRequest for alerts object properties when working with alerts rules.

Added

Added the PatternMatchRequest object, which includes the following properties:

• entityType
• operatorType
• values

Changed the schema name of PatternMatch to PatternMatchRequest for the following alerts objects:

• CreateDagDurationAlertRules
• CreateDagFailureAlertRules
• CreateDagSuccessAlertRules
• CreateDagTimelinessAlertRules
• CreateTaskDurationAlertRules
• CreateTaskFailureAlertRules
• UpdateDagDurationAlertRules
• UpdateDagFailureAlertRules
• UpdateDagSuccessAlertRules
• UpdateDagTimelinessAlertRules
• UpdateTaskDurationAlertRules
• UpdateTaskFailureAlertRules

Summary

Added the ability to work with Astro Alerts and their Notification Channels through the Astro API, with the new alerts and notification-channels endpoints.

Added

New endpoints:

• GET /organizations/{organizationId}/alerts to list Alerts in a Workspace or Deployment.
• POST /organizations/{organizationId}/alerts to create an Alert for a Deployment or Workspace.
• GET /organizations/{organizationId}/alerts/{alertId} to retrieve details about a specific Alert.
• POST /organizations/{organizationId}/alerts/{alertId} to update an existing Alert.
• DEL /organizations/{organizationId}/alerts/{alertId} to delete an Alert.
• GET /organizations/{organizationId}/notification-channels to list Alert Notification Channels.
• POST /organizations/{organizationId}/notification-channels to create an Alert Notification Channel.
• GET /organizations/{organizationId}/alerts/{notificationChannelId} to retrieve details about a specific Alert Notification Channel.
• POST /organizations/{organizationId}/alerts/{notificationChannelId} to update an existing Alert Notification Channel.
• DEL /organizations/{organizationId}/alerts/{notificationChannelId} to delete an Alert Notification Channel.

Summary

Added the new schmea, bundle, as a deploy type for the Deploy endpoint, allowing you to use dbt deploys via the Astro API.

Added

New object schema for the Deploy object at /organizations/{organizationId}/deployments/{deploymentId}/deploys:

• Bundle

Which includes the following new properties:

• bundleType
• currentVersion
• deployId
• desiredVersion
• mountPath

New properties are also added to the following endpoints:

• POST organizations/{organizationId}/deployments/{deploymentId}/deploys

  • bundleMountPath
  • bundleType

• GET organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}

  • bundleMountPath
  • bundleUploadUrl
  • bundles

• POST organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}/finalize:

  • bundleTarballVersion