Skip to content

Commit

Permalink
add generated files for oss artifacts improvement
Browse files Browse the repository at this point in the history
Signed-off-by: dahu.kdh <dahu.kdh@alibaba-inc.com>
  • Loading branch information
DahuK committed Jul 28, 2023
1 parent f6a540c commit 1e6a724
Show file tree
Hide file tree
Showing 30 changed files with 2,237 additions and 0 deletions.
32 changes: 32 additions & 0 deletions api/jsonschema/schema.json

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

32 changes: 32 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.

4 changes: 4 additions & 0 deletions docs/executor_swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -2707,14 +2707,18 @@ save/load the directory appropriately.

| Name | Type | Go type | Required | Default | Description | Example |
|------|------|---------|:--------:| ------- |-------------|---------|
| OidcProviderARN | string| `string` | | | OidcProviderARN is the Alibaba Cloud Resource Name (ARN) of the OIDC IdP. | |
| OidcTokenFile | string| `string` | | | OidcTokenFile is the file path of the OIDC token. | |
| 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 | |
| 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` | | | | |
| roleARN | string| `string` | | | RoleARN is the Alibaba Cloud Resource Name(ARN) of the role to assume. | |
| secretKeySecret | [SecretKeySelector](#secret-key-selector)| `SecretKeySelector` | | | | |
| securityToken | string| `string` | | | SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm | |
| useSDKCreds | boolean| `bool` | | | UseSDKCreds tells the driver to figure out credentials based on sdk defaults. | |



Expand Down
8 changes: 8 additions & 0 deletions docs/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -3450,14 +3450,18 @@ OSSArtifact is the location of an Alibaba Cloud OSS artifact
### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`OidcProviderARN`|`string`|OidcProviderARN is the Alibaba Cloud Resource Name (ARN) of the OIDC IdP.|
|`OidcTokenFile`|`string`|OidcTokenFile is the file path of the OIDC token.|
|`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|
|`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|
|`roleARN`|`string`|RoleARN is the Alibaba Cloud Resource Name(ARN) of the role to assume.|
|`secretKeySecret`|[`SecretKeySelector`](#secretkeyselector)|SecretKeySecret is the secret selector to the bucket's secret key|
|`securityToken`|`string`|SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm|
|`useSDKCreds`|`boolean`|UseSDKCreds tells the driver to figure out credentials based on sdk defaults.|

## RawArtifact

Expand Down Expand Up @@ -4192,14 +4196,18 @@ OSSArtifactRepository defines the controller configuration for an OSS artifact r
### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`OidcProviderARN`|`string`|OidcProviderARN is the Alibaba Cloud Resource Name (ARN) of the OIDC IdP.|
|`OidcTokenFile`|`string`|OidcTokenFile is the file path of the OIDC token.|
|`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|
|`endpoint`|`string`|Endpoint is the hostname of the bucket endpoint|
|`keyFormat`|`string`|KeyFormat is defines the format of how to store keys. Can reference workflow variables|
|`lifecycleRule`|[`OSSLifecycleRule`](#osslifecyclerule)|LifecycleRule specifies how to manage bucket's lifecycle|
|`roleARN`|`string`|RoleARN is the Alibaba Cloud Resource Name(ARN) of the role to assume.|
|`secretKeySecret`|[`SecretKeySelector`](#secretkeyselector)|SecretKeySecret is the secret selector to the bucket's secret key|
|`securityToken`|`string`|SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm|
|`useSDKCreds`|`boolean`|UseSDKCreds tells the driver to figure out credentials based on sdk defaults.|

## S3ArtifactRepository

Expand Down
Loading

0 comments on commit 1e6a724

Please sign in to comment.