设置示例代码库

示例代码库是一个 Git 代码库,其中包含您创建的自定义示例,您的团队可以使用这些示例来开发应用。

这意味着,在组织或团队中,您可以使用 Cloud Code 设置示例代码库并针对您的组织进行自定义,以提供一组可供其他人使用的标准入门应用、服务和基础架构配置。这有助于使新项目与贵组织的首选技术堆栈和标准保持一致,并鼓励在开发周期开始时采用最佳做法。

示例代码库可以是您已经创建好的示例应用的现有代码库,或者您想要让其他人使用的一组新样本集。您只需要将示例描述符文件添加到代码库,以便使用 Cloud Code 将其导入。

示例代码库准备就绪之后,您就可以轻松将其与您的团队共享;它们要求设置 Cloud Code,还需要待使用的示例代码库的 Git 网址。对于私有 Git 代码库,只有有权访问代码库的成员才能使用底层自定义示例。

如需查看示例代码库的设置示例,请参阅此代码库

创建新的示例代码库

如果您要创建要使用的全新示例代码库,请按以下步骤操作:

  1. 创建新的 Git 代码库。

    您的 Git 代码库可以远程托管,也可以驻留在本地机器上。本示例使用全新的 GitHub 代码库“custom-sample-repo”。

    GitHub 代码库创建界面,其中的代码库名称字段填充了“custom-sample-repo”

  2. 将示例目录添加到此代码库中。

    您的示例目录可以包含任何内容,可以位于代码库中的任何位置。在此示例中,“hello-world”和“kubernetes-custom-sample”有两个示例目录已添加到“custom-sample-repo”。

    强烈建议提供 readme 文件,并在其中说明如何使用自定义示例。

    “custom-sample-repo”有两个基本示例目录:“hello-world”和“kubernetes-custom-sample”

  3. 创建示例描述符文件

    示例描述符文件为 Cloud Code 提供有关示例的信息,以正确创建您的应用。此文件必须命名为 .cctemplate(位于根目录中),并且必须在示例描述符文件架构部分中定义架构。

使用现有代码库

如果您想要使用现有代码库,则仍然需要创建示例描述符文件。此文件为 Cloud Code 提供有关您的示例的信息,以保证正确创建应用。

您的示例描述符文件必须命名为 .cctemplate(位于根目录中),并且必须在示例描述符文件架构部分中定义架构。

示例描述符架构

密钥 说明 类型
元数据 Cloud Code 用于读取的元数据。符合元数据架构 元数据
模板 代码库中包含的示例数组。此数组中的对象应符合示例架构 Array<Sample>
名称(可选) 示例代码库的名称。 字符串

示例

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

示例架构

密钥 说明 类型
路径 示例在代码库中的位置。

路径表示相对于代码库的根目录的路径。

字符串
名称 示例的名称。

选择一个示例以用作构建应用的基础时,此名称会在 IDE 中显示。

字符串
说明(可选) 示例的说明。

选择一个示例以用作构建应用的基础时,此名称会在 IDE 中显示。

字符串

示例

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

元数据架构

密钥 说明 类型
版本 正在使用的示例架构的版本。目前唯一有效的版本是 1 字符串

示例

{
   "version":"1"
}

获取支持

如需发送反馈,请在 GitHub 上报告问题,或者在 Stack Overflow 上提问。