Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Supports configuring RRSA in OSS Artifacts. Part of#13973 #13974

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions api/jsonschema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 38 additions & 0 deletions api/openapi-spec/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 24 additions & 0 deletions docs/executor_swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -2381,6 +2381,7 @@ save/load the directory appropriately.
| accessKeySecret | [SecretKeySelector](#secret-key-selector)| `SecretKeySelector` | | | | |
| bucket | string| `string` | | | Bucket is the name of the bucket | |
| createBucketIfNotPresent | boolean| `bool` | | | CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist | |
| credentialsConfig | [OSSCredentialsConfig](#o-s-s-credentials-config)| `OSSCredentialsConfig` | | | | |
| endpoint | string| `string` | | | Endpoint is the hostname of the bucket endpoint | |
| key | string| `string` | | | Key is the path in the bucket where the artifact resides | |
| lifecycleRule | [OSSLifecycleRule](#o-s-s-lifecycle-rule)| `OSSLifecycleRule` | | | | |
Expand All @@ -2390,6 +2391,29 @@ save/load the directory appropriately.



### <span id="o-s-s-credentials-config"></span> OSSCredentialsConfig


> OSSCredentialsConfig specifies the credential configuration for OSS






**Properties**

| Name | Type | Go type | Required | Default | Description | Example |
|------|------|---------|:--------:| ------- |-------------|---------|
| oIDCProviderArn | string| `string` | | | OidcProviderARN is the Alibaba Cloud Resource Name (ARN) of the OIDC IdP. | |
| oIDCTokenFilePath | string| `string` | | | OidcTokenFile is the file path of the OIDC token. | |
| roleArn | string| `string` | | | RoleARN is the Alibaba Cloud Resource Name(ARN) of the role to assume. | |
| roleSessionName | string| `string` | | | RoleSessionName is the session name of the role to assume. | |
| sTSEndpoint | string| `string` | | | STSEndpoint is the endpoint of the STS service. | |
| type | string| `string` | | | Type specifies the credential type. | |



### <span id="o-s-s-lifecycle-rule"></span> OSSLifecycleRule


Expand Down
16 changes: 16 additions & 0 deletions docs/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -3611,6 +3611,7 @@ OSSArtifact is the location of an Alibaba Cloud OSS artifact
|`accessKeySecret`|[`SecretKeySelector`](#secretkeyselector)|AccessKeySecret is the secret selector to the bucket's access key|
|`bucket`|`string`|Bucket is the name of the bucket|
|`createBucketIfNotPresent`|`boolean`|CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist|
|`credentialsConfig`|[`OSSCredentialsConfig`](#osscredentialsconfig)|CredentialsConfig specifies the credential configuration for OSS|
|`endpoint`|`string`|Endpoint is the hostname of the bucket endpoint|
|`key`|`string`|Key is the path in the bucket where the artifact resides|
|`lifecycleRule`|[`OSSLifecycleRule`](#osslifecyclerule)|LifecycleRule specifies how to manage bucket's lifecycle|
Expand Down Expand Up @@ -4353,6 +4354,7 @@ OSSArtifactRepository defines the controller configuration for an OSS artifact r
|`accessKeySecret`|[`SecretKeySelector`](#secretkeyselector)|AccessKeySecret is the secret selector to the bucket's access key|
|`bucket`|`string`|Bucket is the name of the bucket|
|`createBucketIfNotPresent`|`boolean`|CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist|
|`credentialsConfig`|[`OSSCredentialsConfig`](#osscredentialsconfig)|CredentialsConfig specifies the credential configuration for OSS|
|`endpoint`|`string`|Endpoint is the hostname of the bucket endpoint|
|`keyFormat`|`string`|KeyFormat defines the format of how to store keys and can reference workflow variables.|
|`lifecycleRule`|[`OSSLifecycleRule`](#osslifecyclerule)|LifecycleRule specifies how to manage bucket's lifecycle|
Expand Down Expand Up @@ -4474,6 +4476,20 @@ Header indicate a key-value request header to be used when fetching artifacts ov
|`name`|`string`|Name is the header name|
|`value`|`string`|Value is the literal value to use for the header|

## OSSCredentialsConfig

OSSCredentialsConfig specifies the credential configuration for OSS

### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`oIDCProviderArn`|`string`|OidcProviderARN is the Alibaba Cloud Resource Name (ARN) of the OIDC IdP.|
|`oIDCTokenFilePath`|`string`|OidcTokenFile is the file path of the OIDC token.|
|`roleArn`|`string`|RoleARN is the Alibaba Cloud Resource Name(ARN) of the role to assume.|
|`roleSessionName`|`string`|RoleSessionName is the session name of the role to assume.|
|`sTSEndpoint`|`string`|STSEndpoint is the endpoint of the STS service.|
|`type`|`string`|Type specifies the credential type.|

## OSSLifecycleRule

OSSLifecycleRule specifies how to manage bucket's lifecycle
Expand Down
Loading
Loading