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.

Sign up for GitHub

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

Jump to bottom

doc: update supported properties #940

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −8
Draft

doc: update supported properties #940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions docs/end-user/components/cloud-services/terraform/alibaba-deploy-website.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Alibaba Cloud DEPLOY-WEBSITE

## Description

Deploy a static website in object stroage, like S3 or OSS.
Deploy a static website in Alibaba OSS.

## Examples

Expand All @@ -20,7 +20,10 @@ spec:
properties:
bucket: static-website-example
endpoint: oss-cn-hangzhou.aliyuncs.com
static_web_url: 'https://github.com/cloudflare/cloudflare.github.io.git'
src_url: https://github.com/open-gitops/website.git
prerequisite_cmd: apk add nodejs npm && npm install --global yarn
build_cmd: yarn install && yarn build
generated_dir: public
```

## Specification
Expand All @@ -30,8 +33,11 @@ spec:
Name | Description | Type | Required | Default
------------|------------|------------|------------|------------
bucket | OSS bucket name | string | false |
build_cmd | Commands for building website source code | string | false |
endpoint | OSS bucket endpoint | string | true |
static_web_url | The URL of the static website | string | false |
generated_dir | Directory name of generated static content | string | true |
prerequisite_cmd | Prerequisite commands to setup building env, support Alpine `apk` package manager | string | true |
src_url | The URL of the website source code repository | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |


Expand Down
15 changes: 10 additions & 5 deletions .../current/end-user/components/cloud-services/terraform/alibaba-deploy-website.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 阿里云 DEPLOY-WEBSITE

## 描述

部署一个静态网站到对象存储服务，比如 ASW S3 或 阿里云 OSS。
部署一个静态网站到阿里云 OSS。

## 示例

Expand All @@ -18,9 +18,12 @@ spec:
- name: deploy-website-example
type: deploy-website
properties:
bucket: deploy-website-example
bucket: static-website-example
endpoint: oss-cn-hangzhou.aliyuncs.com
static_web_url: 'https://github.com/cloudflare/cloudflare.github.io.git'
src_url: https://github.com/open-gitops/website.git
prerequisite_cmd: apk add nodejs npm && npm install --global yarn
build_cmd: yarn install && yarn build
generated_dir: public
```

## 参数说明
Expand All @@ -30,11 +33,13 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------|------------|------------|------------|------------
bucket | OSS bucket name | string | false |
build_cmd | Commands for building website source code | string | false |
endpoint | OSS bucket endpoint | string | true |
static_web_url | The URL of the static website | string | false |
generated_dir | Directory name of generated static content | string | true |
prerequisite_cmd | Prerequisite commands to setup building env, support Alpine `apk` package manager | string | true |
src_url | The URL of the website source code repository | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |


#### writeConnectionSecretToRef

名称 | 描述 | 类型 | 是否必须 | 默认值
Expand Down