Skip to content
This repository has been archived by the owner on Oct 4, 2024. It is now read-only.

Commit

Permalink
Merge pull request #75 from ruiyaoOps/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
troy-ameigh authored Feb 23, 2022
2 parents 0d04ce2 + 264d6af commit dc0d919
Show file tree
Hide file tree
Showing 15 changed files with 335 additions and 631 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ __pycache__
/index.html
/.python-version
/.taskcat_overrides.yml
/tmp
1 change: 1 addition & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @troy-ameigh
2 changes: 1 addition & 1 deletion docs/languages/docs-cn/partner_editable/_settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:partner-company-name: 青云QingCloud
:doc-month: November
:doc-year: 2020
:partner-contributors: 周小四、周鹏飞、于爽、徐文涛和刘金辉,青云QingCloud
:partner-contributors: 周小四、周鹏飞、于爽、姚锐、徐文涛和刘金辉,青云QingCloud
:quickstart-contributors: Troy Ameigh, AWS Quick Start team
:deployment_time: 40–50 minutes
:default_deployment_region: us-east-1
Expand Down
30 changes: 9 additions & 21 deletions docs/languages/docs-cn/partner_editable/additional_info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
== 测试部署
// If steps are required to test the deployment, add them here. If not, remove the heading

. 使用您配置好的密钥对和用户名 `ec2-user` 登录堡垒主机。您可以从 AWS CloudFormation 控制台的*输出*选项卡中获取堡垒主机的 IP 地址。
. 使用您配置好的密钥对和用户名 `ec2-user` 登录堡垒主机。您可以从 AWS CloudFormation 控制台的 *输出*选项卡中获取堡垒主机的 IP 地址。

ssh -i "~/.ssh/cap.pem" ec2-user@12.23.34.45

Expand All @@ -19,31 +19,19 @@

$ helm version

* AWS CLI 版本:

$ aws -version

* Cf 版本:

$ cf -version

* Git 版本:

$ git version

[start=3]
. 通过堡垒主机确认 Amazon EKS 集群的健康状况。使用安装好的 `kubectl` 和 `helm` 命令来确认对环境的访问以及集群和软件包的运行状态。如果日志中输出欢迎信息,则说明安装成功。

$ kubectl cluster-info

$ kubectl get nodes

$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='\{.items[0].metadata.name}') -f
$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f

$ kubectl get pod –all-namespaces
$ kubectl get pods --all-namespaces

[start=4]
. 在输出列表中检索生成的 KubeSphere 控制台 URL。在浏览器中访问 KubeSphere 控制台,并使用 `KubeSphereConsolePassword` 定义的管理员账户和密码登录 KubeSphere 控制台。
. 在堆栈的 *输出*列表中检索生成的 KubeSphere 控制台 URL。在浏览器中访问 KubeSphere 控制台,并使用 `KubeSphereConsolePassword` 定义的管理员账户和密码登录 KubeSphere 控制台。


[#KubeSphereLogin1]
Expand All @@ -64,24 +52,24 @@ image::../images/image5.png[Architecture,width=648,height=439]

在 Amazon EKS 集群上运行 KubeSphere 容器平台的最佳配置要求至少有一个工作节点,该节点至少有 16GiB RAM 和 4 个 CPU。建议您启用这些可插拔组件,以体验 KubeSphere 提供的全栈特性和功能。如果 KubeSphere 以最小化安装,您仍然可以通过编辑集群配置来启用可插拔组件,如下所示:

使用管理员账户访问*集群管理*。选择 EKS 集群,并从左侧菜单中选择*自定义资源 CRD*,搜索 *ClusterConfiguration*。
使用管理员账户访问 *集群管理*。选择 EKS 集群,并从左侧菜单中选择 *自定义资源 CRD*,搜索 *ClusterConfiguration*。



image::../images/image6.png[Architecture,width=648,height=439]

选择 *ClusterConfiguration* 资源页,点击列表右侧的 *···*,选择*编辑配置文件*。
选择 *ClusterConfiguration* 资源页,点击列表右侧的 *···*,选择 *编辑配置文件*。

image::../images/image7.png[Architecture,width=648,height=439]


下拉至 *spec* 部分,将您想要启用的可插拔组件从 *false* 更改为 *true*。最后,选择*更新*来保存您的更改,后端会自动开始安装。
下拉至 *spec* 部分,将您想要启用的可插拔组件从 *false* 更改为 *true*。最后,选择 *更新*来保存您的更改,后端会自动开始安装。

image::../images/image8.png[Architecture,width=648,height=439]

从*工具箱*(**右下角**)打开 *Web kubectl*,查看安装日志:
*工具箱*(**右下角**)打开 *Web kubectl*,查看安装日志:

$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='\{.items[0].metadata.name}') -f
$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f

如果您在输出日志中看到欢迎信息,可插拔组件便可供使用。

Expand Down
4 changes: 2 additions & 2 deletions docs/languages/docs-cn/partner_editable/deploy_steps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ WARNING: 如果您将 {partner-product-short-name} 部署至现有 VPC 中,请
NOTE: 此部署包括 Amazon EFS,目前并非所有 AWS 区域都支持 Amazon EFS。有关当前支持 Amazon EFS 的区域列表,请参见 https://docs.aws.amazon.com/general/latest/gr/elasticfilesystem.html[Amazon Elastic File System endpoints and quotas^]。

[start=3]
. 在*创建堆栈*页面,保持模板的默认设置,然后选择*下一步*。
. 在*指定堆栈详细信息*页面,根据需要更改堆栈名称,查看模板的各项参数并为需要输入的参数提供值。对于所有其他参数,查看默认设置,并根据需要进行自定义。
. 在 *创建堆栈*页面,保持模板的默认设置,然后选择 *下一步*。
. 在 *指定堆栈详细信息*页面,根据需要更改堆栈名称,查看模板的各项参数并为需要输入的参数提供值。对于所有其他参数,查看默认设置,并根据需要进行自定义。

//In the following tables, parameters are listed by category and described separately for the two deployment options:

Expand Down
14 changes: 7 additions & 7 deletions docs/languages/docs-cn/partner_editable/faq_troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

== FAQ

*问:*启动此快速入门时提示 *CREATE_FAILED* 错误。
*问:启动此快速入门时提示 `CREATE_FAILED` 错误。*

*答:*如果 AWS CloudFormation 创建堆栈失败,建议您将*失败时回滚*设置为*已禁用*并重启该模板。(此设置在 AWS CloudFormation 控制台*选项*页面的*高级*部分下。)设置后,该堆栈的状态会保留,实例会持续运行以便您解决问题。(对于 Windows 系统, 请查看 `%ProgramFiles%\Amazon\EC2ConfigService` 和 `C:\cfn\log` 中的日志文件。)
答:如果 AWS CloudFormation 创建堆栈失败,建议您将 *失败时回滚*设置为 *已禁用*并重启该模板。(此设置在 AWS CloudFormation 控制台 *选项*页面的 *高级*部分下。)设置后,该堆栈的状态会保留,实例会持续运行以便您解决问题。(对于 Windows 系统, 请查看 `%ProgramFiles%\Amazon\EC2ConfigService` 和 `C:\cfn\log` 中的日志文件。)
// If you’re deploying on Linux instances, provide the location for log files on Linux, or omit this sentence.

WARNING: 当您将*失败时回滚*设置为*已禁用*时,该堆栈仍然会在 AWS 上持续计费。请确保您在解决问题后删除该堆栈。有关更多信息,请参见 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/troubleshooting.html[AWS CloudFormation 疑难解答^]。
WARNING: 当您将 *失败时回滚*设置为 *已禁用*时,该堆栈仍然会在 AWS 上持续计费。请确保您在解决问题后删除该堆栈。有关更多信息,请参见 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/troubleshooting.html[AWS CloudFormation 疑难解答^]。

*问:*部署 AWS CloudFormation 模板时提示大小限制错误。
*问:部署 AWS CloudFormation 模板时提示大小限制错误。*

*答:*建议您通过此指南中的链接或另一个 S3 存储桶去启动快速入门模板。如果您从本地副本部署模板,或从 S3 存储桶以外的地方部署模板,则可能会发生模板大小限制问题。有关更多信息,请参见 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html[AWS CloudFormation 配额^]。
答:建议您通过此指南中的链接或另一个 S3 存储桶去启动快速入门模板。如果您从本地副本部署模板,或从 S3 存储桶以外的地方部署模板,则可能会发生模板大小限制问题。有关更多信息,请参见 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html[AWS CloudFormation 配额^]。

*问:*如何修改语言?
*问:如何修改语言?*

*答:*从控制台右上角的下拉菜单中选择*个人设置*以切换语言。KubeSphere 控制台支持英文、西班牙文、简体中文和繁体中文。
答:从控制台右上角的下拉菜单中选择 *个人设置*以切换语言。KubeSphere 控制台支持英文、西班牙文、简体中文和繁体中文。
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ KubeSphere 是一个多租户企业级容器平台,拥有全栈的自动化运
* DevOps(基于 https://www.jenkins.io/[Jenkins^] 的持续集成和持续交付)
* 应用程序生命周期管理
* 应用商店
* 边缘计算(基于 https://kubeedge.io/zh/[KubeEdge^])
* 丰富的可观察性功能,包括监控、日志、审计、告警和通知
* 服务网格(基于 https://istio.io/[Istio^] 和 https://www.jaegertracing.io/[Jaeger^])
* 企业级多租户
Expand Down
8 changes: 4 additions & 4 deletions docs/languages/docs-cn/translate-only/deployment_steps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ include::../{generateddir}/parameters/index.adoc[]
endif::parameters_as_appendix[]

[start=5]
. 在*配置堆栈选项*页面,您可以为堆栈中的资源 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html[指定标签^](键值对)并 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html[设置高级选项^]。操作完成后,选择*下一步*
. 在*审核*页面,审核并确认模板设置。勾选*功能*下的两个复选框,以确认该模板创建 IAM 资源并可能需要自动扩展宏的能力。
. 选择*创建堆栈*来部署堆栈。
. 在 *配置堆栈选项*页面,您可以为堆栈中的资源 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html[指定标签^](键值对)并 https://docs.aws.amazon.com/zh_cn/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html[设置高级选项^]。操作完成后,选择*下一步*
. 在 *审核*页面,审核并确认模板设置。勾选 *功能*下的两个复选框,以确认该模板创建 IAM 资源并可能需要自动扩展宏的能力。
. 选择 *创建堆栈*来部署堆栈。
ifndef::partner-product-short-name[. 监控该堆栈的状态。当状态为 *CREATE_COMPLETE* 时,{partner-product-name} 部署准备就绪。]
ifdef::partner-product-short-name[. 监控该堆栈的状态。当状态为 *CREATE_COMPLETE* 时,{partner-product-short-name} 部署准备就绪。]
. 如 <<cfn_outputs>> 所示,使用堆栈*输出*选项卡下显示的值来查看创建好的资源。
. 如 <<cfn_outputs>> 所示,使用堆栈 *输出*选项卡下显示的值来查看创建好的资源。

:xrefstyle: short
[#cfn_outputs]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ ifndef::disable_requirements[]
endif::disable_requirements[]

==== 资源配额
如有必要,请为以下资源申请 https://amazonaws-china.com/cn/getting-started/hands-on/request-service-quota-increase/[服务配额^]。如果您当前使用的一些服务已经消耗了以下的配额资源,而部署此快速入门会导致资源超出默认配额,请提前申请扩大配额。https://console.aws.amazon.com/servicequotas/home?region=us-east-2#!/[服务配额控制台^]显示您当前服务的资源用量及配额使用情况。有关更多信息,请参见 https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html[什么是服务配额?^]以及 https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html[AWS 服务配额^]。
如有必要,请为以下资源申请 https://amazonaws-china.com/cn/getting-started/hands-on/request-service-quota-increase/[服务配额^]。如果您当前使用的一些服务已经消耗了以下的配额资源,而部署此快速入门会导致资源超出默认配额,请提前申请扩大配额。 https://console.aws.amazon.com/servicequotas/home?region=us-east-2#!/[服务配额控制台^]显示您当前服务的资源用量及配额使用情况。有关更多信息,请参见 https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html[什么是服务配额?^]以及 https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html[AWS 服务配额^]。

ifndef::production_build[]
_**This portion of the deployment guide is located at `docs/{specificdir}/service_limits.adoc`**_
Expand Down
18 changes: 4 additions & 14 deletions docs/partner_editable/additional_info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,16 @@

$ helm version

* AWS CLI version:

$ aws -version

* Cf version:

$ cf -version

* Git version

$ git version

[start=3]
. Verify the health of the Amazon EKS cluster through the bastion host. Use the installed `kubectl` and `helm` commands to verify access to the environment and the running state of the cluster and packages. The installation was successful if you see the welcome-information outputs in the log.

$ kubectl cluster-info

$ kubectl get nodes

$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='\{.items[0].metadata.name}') -f
$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f

$ kubectl get pods --all-namespaces

[start=4]
. Retrieve the generated URL of the KubeSphere console from the outputs list. Access it in your browser, and log in to the KubeSphere console using the administrator account and password defined by `KubeSphereConsolePassword`.
Expand Down Expand Up @@ -78,7 +68,7 @@ image::../images/image8.png[Architecture,width=648,height=439]

Open the *Web kubectl* from *Toolbox* (**bottom right**), and inspect the installation logs:

$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='\{.items[0].metadata.name}') -f
$ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f

When you see welcome information in the output logs, the pluggable components are ready to use.

Expand Down
1 change: 1 addition & 0 deletions docs/partner_editable/product_description.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This Quick Start is powered by AWS CloudFormation templates that help IAM users
* DevOps (continuous integration and continuous delivery based on https://www.jenkins.io/[Jenkins^])
* Application lifecycle management
* An app store
* Edge computing (based on https://kubeedge.io/en/[KubeEdge^])
* Rich observability for monitoring, logging, auditing, alerting, and notifying
* A service mesh for distributed microservices (based on https://istio.io/[Istio^] and https://www.jaegertracing.io/[Jaeger^])
* Enterprise multitenancy
Expand Down
2 changes: 1 addition & 1 deletion submodules/quickstart-amazon-eks
29 changes: 10 additions & 19 deletions templates/kubesphere-entrypoint-existing-vpc.template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,15 @@ Metadata:
- Label:
default: AWS Quick Start configuration
Parameters:
- EKSClusterName
- QSS3BucketName
- QSS3KeyPrefix
- QSS3BucketRegion
- ConfigSetName
- PerAccountSharedResources
- PerRegionSharedResources
- Label:
default: Configures the KubeSphere system and pluggable components
Parameters:
- KubeSphereConsolePassword
- Openpitrix
- Devops
- Servicemesh
Expand Down Expand Up @@ -90,6 +89,8 @@ Metadata:
default: Private subnet 2 ID
PrivateSubnet3ID:
default: Private subnet 3 ID
EKSClusterName:
default: EKS cluster name
QSS3BucketName:
default: Quick Start S3 bucket name
QSS3KeyPrefix:
Expand All @@ -104,8 +105,6 @@ Metadata:
default: Node instance type
NumberOfNodes:
default: Number of nodes
KubeSphereConsolePassword:
default: KubeSphereConsolePassword
Openpitrix:
default: Openpitrix
Devops:
Expand All @@ -128,8 +127,6 @@ Metadata:
default: Networkpolicy
MetricsServer:
default: MetricsServer
ConfigSetName:
default: ConfigSetName
PerAccountSharedResources:
default: Per-account shared resources
PerRegionSharedResources:
Expand Down Expand Up @@ -172,6 +169,10 @@ Parameters:
Type: "AWS::EC2::Subnet::Id"
Description: ID of the private subnet in Availability Zone 3 of your existing VPC (e.g., subnet-abd39039).
Default: ""
EKSClusterName:
Type: String
Default: ""
Description: "(Optional) Name for the EKS cluster. If left blank, one is auto-generated. This must be unique within the Region."
QSS3BucketName:
AllowedPattern: ^[0-9a-zA-Z]+([0-9a-zA-Z-]*[0-9a-zA-Z])*$
ConstraintDescription: Quick Start bucket name can include numbers, lowercase
Expand Down Expand Up @@ -268,11 +269,6 @@ Parameters:
Default: 1
Description: Number of Amazon EKS node instances. The default is one for each Availability Zones.
Type: Number
KubeSphereConsolePassword:
Type: String
AllowedPattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[$@^$!%*?#&])[A-Za-z\d$@^$!%*?#&]{8,}
Description: Password of KubeSphere console must be at least 8 characters, including numbers, uppercase letters, lowercase letters, and special characters (!@#$%^&*?).
NoEcho: True
Openpitrix:
Type: String
AllowedValues: [true, false]
Expand Down Expand Up @@ -328,10 +324,6 @@ Parameters:
AllowedValues: [true, false]
Default: true
Description: '(Optional) Users can install "MetricsServer" to enable HPA (Horizontal Pod Autoscaler), which automatically scales the number of pods, deployments, or stateful sets based on observed CPU utilization.'
ConfigSetName:
Type: String
Default: ""
Description: 'Name for the configuration set. This applies if you launched the advanced configuration stack. The name must match the "ConfigSetName" parameter.'
PerAccountSharedResources:
Type: String
AllowedValues: ['AutoDetect', 'Yes', 'No']
Expand Down Expand Up @@ -369,6 +361,7 @@ Resources:
- S3Region: !If [UsingDefaultBucket, !Ref 'AWS::Region', !Ref QSS3BucketRegion]
S3Bucket: !If [UsingDefaultBucket, !Sub '${QSS3BucketName}-${AWS::Region}', !Ref QSS3BucketName]
Parameters:
EKSClusterName: !Ref EKSClusterName
QSS3BucketName: !Ref QSS3BucketName
QSS3BucketRegion: !Ref QSS3BucketRegion
QSS3KeyPrefix: !Sub "${QSS3KeyPrefix}submodules/quickstart-amazon-eks/"
Expand All @@ -377,7 +370,6 @@ Resources:
RemoteAccessCIDR: !Ref RemoteAccessCIDR
PerRegionSharedResources: !Ref PerRegionSharedResources
PerAccountSharedResources: !Ref PerAccountSharedResources
ConfigSetName: !Ref 'ConfigSetName'
KeyPairName: !Ref 'KeyPairName'
PrivateSubnet1ID: !Ref PrivateSubnet1ID
PublicSubnet1ID: !Ref PublicSubnet1ID
Expand Down Expand Up @@ -412,7 +404,6 @@ Resources:
Parameters:
KubeClusterName: !GetAtt EKSClusterStack.Outputs.EKSClusterName
KubeConfigKmsContext: "EKSQuickStart"
KubeSphereConsolePassword: !Ref KubeSphereConsolePassword
Openpitrix: !Ref Openpitrix
Devops: !Ref Devops
Servicemesh: !Ref Servicemesh
Expand All @@ -435,5 +426,5 @@ Outputs:
Value: !GetAtt KubeSphereStack.Outputs.KubeSpherePortConsole
KubeSphereConsoleLoginUser:
Value: admin
KubeSphereConsoleLoginPassword:
Value: !GetAtt KubeSphereStack.Outputs.KubeSphereConsoleLoginPassword
KubeSphereConsoleDefaultAdminLoginPassword:
Value: !GetAtt KubeSphereStack.Outputs.KubeSphereConsoleDefaultAdminLoginPassword
Loading

0 comments on commit dc0d919

Please sign in to comment.