docs: add example and verify for alibaba-oss-webstie (#897)
* docs: add example and verify for alibaba-oss-webstie Signed-off-by: lunarwhite <dwcn22@outlook.com> * update zh-cn doc Signed-off-by: lunarwhite <dwcn22@outlook.com>
This commit is contained in:
Yuedong Wu
GitHub
parent
3ff1fbebab
commit
2272fd28ee
|
|
@ -98,7 +98,7 @@ title: Supported Cloud Resource list
|
|||
| | | [nas](./terraform/alibaba-nas.md) | Terraform configuration for Alicloud NAS | false |
|
||||
| | | [network with nat](./terraform/alibaba-network-with-nat.md) | Build VPC and Nat gateway network environment and bind EIP, add SNAT and DNAT entries on AliCloud based on Terraform module | false |
|
||||
| | | [oss](./terraform/alibaba-oss.md) | Terraform configuration for Alibaba Cloud OSS | true |
|
||||
| | | [oss website](./terraform/alibaba-oss-website.md) | Alibaba Cloud OSS static webstie bucket | false |
|
||||
| | | [oss website](./terraform/alibaba-oss-website.md) | Alibaba Cloud OSS static webstie bucket | true |
|
||||
| | | [private zone](./terraform/alibaba-private-zone.md) | Terraform-based modules are used to create a Private Zone on AliCloud, while you can add records to the Zone and associate it with a VPC | false |
|
||||
| | | [rabbitmq](./terraform/alibaba-rabbitmq.md) | Create a RabbitMQ based on Terraform module in Ali cloud | false |
|
||||
| | | [ram](./terraform/alibaba-ram.md) | Create RAM User instances on AliCloud based on Terraform module | false |
|
||||
|
|
|
|||
|
|
@ -6,8 +6,29 @@ title: Alibaba Cloud OSS-WEBSITE
|
|||
|
||||
Alibaba Cloud OSS static webstie bucket.
|
||||
|
||||
## Examples
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: alibaba-cloud-oss-webstie
|
||||
spec:
|
||||
components:
|
||||
- name: oss-website-example
|
||||
type: alibaba-oss-website
|
||||
properties:
|
||||
acl: public-read
|
||||
bucket: oss-website-example
|
||||
index_document: index.html
|
||||
error_document: 404.html
|
||||
writeConnectionSecretToRef:
|
||||
name: oss-website-conn
|
||||
```
|
||||
|
||||
## Specification
|
||||
|
||||
### Properties
|
||||
|
||||
Name | Description | Type | Required | Default
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
|
|
|
|||
|
|
@ -155,7 +155,7 @@ title: 云资源列表
|
|||
| | | [nas](./terraform/alibaba-nas.md) | Terraform configuration for Alicloud NAS | false |
|
||||
| | | [network with nat](./terraform/alibaba-network-with-nat.md) | Build VPC and Nat gateway network environment and bind EIP, add SNAT and DNAT entries on AliCloud based on Terraform module | false |
|
||||
| | | [oss](./terraform/alibaba-oss.md) | Terraform configuration for Alibaba Cloud OSS | true |
|
||||
| | | [oss website](./terraform/alibaba-oss-website.md) | Alibaba Cloud OSS static webstie bucket | false |
|
||||
| | | [oss website](./terraform/alibaba-oss-website.md) | Alibaba Cloud OSS static webstie bucket | true |
|
||||
| | | [private zone](./terraform/alibaba-private-zone.md) | Terraform-based modules are used to create a Private Zone on AliCloud, while you can add records to the Zone and associate it with a VPC | false |
|
||||
| | | [rabbitmq](./terraform/alibaba-rabbitmq.md) | Create a RabbitMQ based on Terraform module in Ali cloud | false |
|
||||
| | | [ram](./terraform/alibaba-ram.md) | Create RAM User instances on AliCloud based on Terraform module | false |
|
||||
|
|
|
|||
|
|
@ -4,34 +4,55 @@ title: 阿里云 OSS-WEBSITE
|
|||
|
||||
## 描述
|
||||
|
||||
Alibaba Cloud OSS static webstie bucket。
|
||||
使用阿里云 OSS 托管静态网站。
|
||||
|
||||
## 示例
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: alibaba-cloud-oss-webstie
|
||||
spec:
|
||||
components:
|
||||
- name: oss-website-example
|
||||
type: alibaba-oss-website
|
||||
properties:
|
||||
acl: public-read
|
||||
bucket: oss-website-example
|
||||
index_document: index.html
|
||||
error_document: 404.html
|
||||
writeConnectionSecretToRef:
|
||||
name: oss-website-conn
|
||||
```
|
||||
|
||||
## 参数说明
|
||||
|
||||
### 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write'。 | string | false |
|
||||
bucket | OSS bucket name。 | string | false |
|
||||
error_document | OSS bucket static website error document。 | string | false |
|
||||
index_document | OSS bucket static website index document。 | string | false |
|
||||
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to。 | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write'. | string | false |
|
||||
bucket | OSS bucket name. | string | false |
|
||||
error_document | OSS bucket static website error document. | string | false |
|
||||
index_document | OSS bucket static website index document. | string | false |
|
||||
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to. | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
|
||||
|
||||
|
||||
#### writeConnectionSecretToRef
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
name | The secret name which the cloud resource connection will be written to。 | string | true |
|
||||
namespace | The secret namespace which the cloud resource connection will be written to。 | string | false |
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
name | The secret name which the cloud resource connection will be written to. | string | true |
|
||||
namespace | The secret namespace which the cloud resource connection will be written to. | string | false |
|
||||
|
||||
|
||||
### 输出
|
||||
|
||||
如果设置了 `writeConnectionSecretToRef`，一个 Kubernetes Secret 将会被创建，并且，它的数据里有这些键（key）：
|
||||
|
||||
名称 | 描述
|
||||
------------ | -------------
|
||||
BUCKET_NAME |
|
||||
名称 | 描述
|
||||
------------ | -------------
|
||||
BUCKET_NAME |
|
||||
EXTRANET_ENDPOINT | OSS bucket external endpoint
|
||||
INTRANET_ENDPOINT | OSS bucket internal endpoint
|
||||
|
|
|
|||
Loading…
Reference in New Issue