使用 Skipper
本节是 Skipper 的 “'三小时游览'”。 它详细描述了如何配置和使用 Skipper 的主要功能集。 我们将介绍 shell、平台、软件包和存储库。
欢迎在 Stack Overflow 上提问。 可以在 Github issues 上提交问题。
12. 船长壳
该 shell 基于 Spring Shell 项目。
shell 的两个最佳功能是 Tab 键补全和命令着色。
在启动 shell 时使用 'help' 命令或参数来获取帮助信息。
使用参数的输出如下:--help
--help
Skipper Options:
--spring.cloud.skipper.client.serverUri=<uri> Address of the Skipper Server [default: http://localhost:7577].
--spring.cloud.skipper.client.username=<USER> Username of the Skipper Server [no default].
--spring.cloud.skipper.client.password=<PASSWORD> Password of the Skipper Server [no default].
--spring.cloud.skipper.client.credentials-provider-command=<COMMAND> Runs an external command, which must return an OAuth Access Token [no default].
--spring.cloud.skipper.client.skip-ssl-validation=<true|false> Accept any SSL certificate (even self-signed) [default: no].
--spring.shell.historySize=<SIZE> Default size of the shell log file [default: 3000].
--spring.shell.commandFile=<FILE> Skipper Shell read commands read from the file(s) and then exits.
--help This message.
12.1. Shell 模式
shell 可以在交互或非交互模式下启动。
在非交互模式下,命令行参数作为 Skipper 命令运行,然后 shell 退出。
如果有任何参数没有 prefix ,则它们被视为要运行的 skipper 命令。spring.cloud.skipper.client
请考虑以下示例:
java -jar spring-cloud-skipper-shell-2.11.5.jar --spring.cloud.skipper.client.serverUri=http://localhost:9123/api
前面的示例启动交互式 shell 并连接到 .
现在考虑以下命令:localhost:9123/api
$ java -jar spring-cloud-skipper-shell-2.11.5.jar --spring.cloud.skipper.client.serverUri=http://localhost:9123/api search
上述命令连接到 ,运行命令,然后退出。localhost:9123/api
search
更常见的用例是从 CI 作业中更新软件包,例如,在 Jenkins 阶段,如以下示例所示:
stage ('Build') {
steps {
checkout([
$class: 'GitSCM',
branches: [
[name: "*/master"]
],
userRemoteConfigs: [
[url: "https://github.com/markpollack/skipper-samples.git"]
]
])
sh '''
VERSION="1.0.0.M1-$(date +%Y%m%d_%H%M%S)-VERSION"
mvn org.codehaus.mojo:versions-maven-plugin:2.3:set -DnewVersion="${VERSION}"
mvn install
java -jar /home/mpollack/software/skipper.jar upgrade --package-name helloworld --release-name helloworld-jenkins --properties version=${VERSION}
'''
}
}
13. 平台
Skipper 支持部署到多个平台。
包含的平台包括 Local、Cloud Foundry 和 Kubernetes。
对于每个平台,您可以配置多个账户。
每个平台在所有平台上都必须全局唯一。account name
通常,different 对应于 Cloud Foundry 的不同组织或空间,以及单个 Kubernetes 集群的不同命名空间。accounts
平台是使用 Spring Boot 的 Externalized Configuration 功能定义的。
为了简化入门体验,如果您的配置中未定义本地平台账户,Skipper 会创建一个名为 .local
default
您可以使用 Spring Cloud Config 的加密和解密功能作为保护凭据的一种方式。
与 Skipper 部署应用程序的位置不同,您还可以在平台上运行 Skipper 服务器本身。 安装部分介绍了在其他平台上的安装。
以下示例 YAML 文件显示了所有三个平台的配置:
spring: cloud: skipper: server: platform: local: accounts: localDevDebug: javaOpts: "-Xdebug" cloudfoundry: accounts: cf-dev: connection: url: https://api.run.pivotal.io org: scdf-ci space: space-mark domain: cfapps.io username: <your-username> password: <your-password> skipSslValidation: false deployment: deleteRoutes: false kubernetes: accounts: minikube: namespace: default
可以在以下类中找到每个平台可用的属性:
-
CloudFoundryDeploymentProperties 和 CloudFoundryConnectionProperties 的 .
deployment:
connection:
14. 软件包
包包含安装应用程序或应用程序组所需的所有信息。 描述应用程序的方法是使用 YAML 文件,该文件提供所有必要的信息来提供帮助 便于搜索托管在 Package Registry 中的应用程序,并将应用程序安装到 平台。
为了便于自定义包,对 YAML 文件进行了模板化。
替换所有值的 YAML 文件的最终版本称为 release 。
Skipper 目前了解如何基于 YAML 文件部署应用程序,该文件包含所需的信息
用于部署应用程序的 Spring Cloud Deployer 或 Cloud Foundry 实现。
它描述了在何处查找应用程序(HTTP、Maven 或 Docker 位置)、应用程序属性(想想 Spring
Boot ) 和部署属性 (例如要使用的内存量) 。manifest
@ConfigurationProperties
14.1. 包格式
包是 YAML 文件的集合,这些文件被压缩到具有以下命名约定的文件中:(例如:)。[PackageName]-[PackageVersion].zip
mypackage-1.0.0.zip
一个包可以定义单个应用程序或一组应用程序。
14.1.1. 单个应用程序
解压缩后,单个应用程序包文件应具有以下目录
结构:mypackage-1.0.0.zip
mypackage-1.0.0
├── package.yml
├── templates
│ └── template.yml
└── values.yml
该文件包含有关包的元数据,用于支持 Skipper 的搜索功能。
该文件包含文件中指定值的占位符。
安装包时,还可以指定占位符值,这些值将覆盖文件中的值。
Skipper 使用的模板引擎是 JMustache。
YAML 文件可以具有 or 扩展名。package.yml
template.yml
values.yml
values.yml
.yml
.yaml
helloworld-1.0.0.zip 或 helloworld-docker-1.0.0.zip 文件是很好的示例,可以用作 “'hand '” 创建自己的包的基础。
可在此处找到该示例的源代码。helloworld
14.1.2. 多个应用程序
一个软件包可以包含捆绑在其中的一组应用程序。 在这些情况下,包的结构将类似于以下内容:
mypackagegroup-1.0.0
├── package.yml
├── packages
│ ├── app1
│ │ ├── package.yml
│ │ ├── templates
│ │ │ └── log.yml
│ │ └── values.yml
│ └── app2
│ ├── package.yml
│ ├── templates
│ │ └── time.yml
│ └── values.yml
└── values.yml
在前面的示例中,still 有自己的 and 来指定软件包
metadata 和要覆盖的值。其中的所有应用程序都被认为是
子包,并遵循类似于单个包的包结构。需要指定这些子包
在根包的目录中,.mypackagegroup
package.yml
values.yml
mypackagegroup
packages
mypackagegroup
ticktock-1.0.0.zip 文件是一个很好的示例,可以用作“手动”创建自己的包的基础。
模板类型为 CloudFoundryApplication 的包目前不支持多个应用程序格式。 |
14.2. 包元数据
该文件指定包元数据。
示例包元数据类似于以下内容:package.yml
# Required Fields apiVersion: skipper.spring.io/v1 kind: SkipperPackageMetadata name: mypackage version: 1.0.0 # Optional Fields packageSourceUrl: https://github.com/some-mypackage-project/v1.0.0.RELEASE packageHomeUrl: https://some-mypackage-project/ tags: skipper, mypackage, sample maintainer: https://github.com/maintainer description: This is a mypackage sample.
必填字段:
-
apiVersion
:此文件所基于的 Package Index 规范版本。 -
kinds
:正在使用的包系统类型。 -
name
:包的名称。 -
version
:包的版本。
目前仅支持的 kind 是 SkipperPackageMetadata。 |
可选字段:
-
packageSourceUrl
:此包的源代码的位置。 -
packageHomeUrl
:包的主页。 -
tags
:用于搜索的标记的逗号分隔列表。 -
maintainer
:谁维护此包。 -
description
:描述包功能的自由格式文本 — 通常显示在搜索结果中。 -
sha256
:包二进制文件的哈希值(尚未强制执行)。 -
iconUrl
:要为此包显示的图标的 URL。 -
origin
:描述此包来源的自由格式文本 — 例如,您的公司名称。
目前,包搜索功能只是与包名称的通配符匹配。 |
包存储库公开一个包含多个元数据文档的文件,并使用标准的三短划线表示法来分隔文档,例如 index.yml。index.yml
---
14.3. 包模板
目前,支持两种类型的应用程序。一个具有 kind,这意味着
只有使用相应的 Spring Cloud Deployer 才能将应用程序部署到目标平台中
实现(CF、Kubernetes Deployer 等)。other 具有 kind,这意味着
使用其清单支持将应用程序直接部署到 Cloud Foundry 中。SpringCloudDeployerApplication
CloudFoundryApplication
14.3.1. Spring Cloud 部署程序
该文件的包结构类似于以下示例中的包结构:template.yml
mypackage-1.0.0
├── package.yml
├── templates
│ └── template.yml
└── values.yml
实际的模板文件名无关紧要,您可以有多个模板文件。这些只需要位于目录内。 |
# template.yml
apiVersion: skipper.spring.io/v1
kind: SpringCloudDeployerApplication
metadata:
name: mypackage
type: sample
spec:
resource: maven://org.mysample:mypackage
resourceMetadata: maven://org.mysample:mypackage:jar:metadata:{{spec.version}}
version: {{spec.version}}
applicationProperties:
{{#spec.applicationProperties.entrySet}}
{{key}}: {{value}}
{{/spec.applicationProperties.entrySet}}
deploymentProperties:
{{#spec.deploymentProperties.entrySet}}
{{key}}: {{value}}
{{/spec.deploymentProperties.entrySet}}
、 和 是必需的。apiVersion
kind
spec.resource
和 定义应用程序可执行文件的位置。该字段定义 Spring Boot Configuration 元数据 jar 的位置,其中包含应用程序的配置属性。这是一个 Spring Boot uber jar
托管在 HTTP 终端节点或 Maven 或 Docker 存储库下。模板占位符的存在是为了
可以轻松升级特定应用程序的版本,而无需创建新的软件包.zip文件。spec.resource
spec.version
spec.resourceMetadata
{{spec.version}}
基于 或 或 。指定 a 的格式遵循 documented
在 Resources 中键入。resource
http://
maven://
docker:
resource
14.3.2. Cloud Foundry
该文件的包结构类似于以下示例中的包结构:template.yml
mypackage-1.0.0
├── package.yml
├── templates
│ └── template.yml
└── values.yml
template.yml
通常包含类似于以下内容的内容:
实际的模板文件名无关紧要,您可以有多个模板文件。这些只需要位于目录内。 |
# template.yml
apiVersion: skipper.spring.io/v1
kind: CloudFoundryApplication
spec:
resource: maven://org.mysample:mypackage
version: {{spec.version}}
manifest:
{{#spec.manifest.entrySet}}
{{key}}: {{value}}
{{/spec.manifest.entrySet}}
其中 values 可以是这样的:
# values.yml
spec:
version: 1.0.0
manifest:
memory: 1024
disk-quota: 1024
a 的可能值为:spec.manifest
钥匙 | 值 | 笔记 |
---|---|---|
|
(字符串) |
buildpack 属性。 |
|
(字符串) |
command 属性。 |
|
(字符串或整数) |
memory 属性,如果 type 为 Integer,则 String 在 CF 中使用相同的格式进行转换,例如 或 。 和 是等效的。 |
|
(字符串或整数) |
disk_quota type 为 Integer 时,String 在 CF 中使用相同的格式进行转换,如 或 。 和 是等效的。 |
|
(整数) |
timeout 属性。 |
|
(整数) |
instances 属性。 |
|
(布尔值) |
no-hostname 属性。 |
|
(布尔值) |
no-route 属性。 |
|
(布尔值) |
random-route 属性。 |
|
(字符串) |
health-check-type 的可能值为 、 或 。 |
|
(字符串) |
health-check-http-endpoint 属性。 |
|
(字符串) |
stack 属性。 |
|
(列表<字符串>) |
services 属性。 |
|
(列表<字符串>) |
domains 属性。 |
|
(列表<字符串>) |
hosts 属性。 |
|
(地图<String,Object>) |
env 属性。 |
请记住,当从命令行给出值时,将按照模板中的定义进行替换。使用模板
格式,List 将以格式给出,Map 将以 格式给出。 |
基于 或 或 。指定 a 的格式遵循 documented
在 Resources 中键入。resource
http://
maven://
docker:
resource
14.3.3. 资源
本部分包含当前支持的资源类型。
HTTP 资源
以下示例显示了 HTTP 的典型规范:
spec:
resource: https://example.com/app/hello-world
version: 1.0.0.RELEASE
基于 HTTP 的资源必须遵循命名约定,以便 Skipper 可以从 and 字段组装完整的 URL,并解析给定 URL 的版本号。
前面引用了位于 .
and 字段的字符后不应有任何数字。resource
version
spec
example.com/app/hello-world-1.0.0.RELEASE.jar
resource
version
-
Docker 资源
以下示例显示了 Docker 的典型规范:
spec:
resource: docker:springcloud/spring-cloud-skipper-samples-helloworld
version: 1.0.0.RELEASE
到 docker 注册表名称的映射如下:
spec:
resource: docker:<user>/<repo>
version: <tag>
Maven 资源
以下示例显示了 Maven 的典型规范:
spec: resource: maven://org.springframework.cloud.samples:spring-cloud-skipper-samples-helloworld:1.0.0.RELEASE version: 1.0.0.RELEASE
到 Maven 对象名称的映射如下
spec:
resource: maven://<maven-group-name>:<maven-artifact-name>
version:<maven-version>
只需指定一个设置即可搜索 Maven 存储库。 此设置适用于所有平台账户。 默认情况下,使用以下配置:
maven:
remoteRepositories:
springRepo: https://repo.spring.io/snapshot
您可以指定其他条目,也可以指定代理属性。
目前,此处对此进行了最好的记录。
实质上,这需要在启动项属性中设置为属性,或者(在推送到 PCF 时)设置,如下所示:manifest.yml
# manifest.yml
...
env:
SPRING_APPLICATION_JSON: '{"maven": { "remote-repositories": { "springRepo": { "url": "https://repo.spring.io/snapshot"} } } }'
...
metadata 部分用于帮助搜索安装后的应用程序。 此功能将在将来的版本中提供。
它包含资源规范和包的属性。spec
表示要从中下载应用程序的资源 URI。
这通常是 Maven 坐标或 Docker 图像 URL。resource
应用程序类型可以具有 和 作为配置属性。SpringCloudDeployerApplication
applicationProperties
deploymentProperties
应用程序属性对应于应用程序本身的属性。
部署属性对应于 Spring Cloud Deployer 执行的部署操作的属性 实现。
模板文件的 The 可以是任何内容,因为 directory 下的所有文件都被加载以应用
模板配置。 |
14.4. 包值
该文件包含模板文件中指定的任何键的默认值。values.yml
例如,在定义一个应用程序的包中,格式如下所示:
version: 1.0.0.RELEASE
spec:
applicationProperties:
server.port: 9090
如果包定义了多个应用程序,请在顶级 YML 部分中提供包的名称以限定该部分的范围。考虑具有以下布局的多应用程序包的示例:spec
ticktock-1.0.0/
├── packages
│ ├── log
│ │ ├── package.yml
│ │ └── values.yml
│ └── time
│ ├── package.yml
│ └── values.yml
├── package.yml
└── values.yml
顶级文件可能类似于以下内容:values.yml
#values.yml
hello: world
time:
appVersion: 1.3.0.M1
deployment:
applicationProperties:
log.level: WARN
trigger.fixed-delay: 1
log:
deployment:
count: 2
applicationProperties:
log.level: WARN
log.name: skipperlogger
前面的文件设置为可用作文件中占位符的变量,并将 .但是,下面的 YML 部分已应用
仅应用于文件,并且 YML 部分仅应用于文件。values.yml
hello
packages\log\values.yml
packages\time\values.yml
time:
packages\time\values.yml
log:
packages\log\values.yml
14.5. 包上传
在上一节所示的结构中创建包后,我们可以使用以下命名方案将其压缩为 zip 文件: [PackageName]-[PackageVersion].zip(例如,mypackage-1.0.0.zip)。
例如,压缩前的包目录将类似于以下内容:
mypackage-1.0.0 ├── package.yml ├── templates │ └── template.yml └── values.yml
zip 文件可以上传到 Skipper 服务器的本地存储库之一。
默认情况下,Skipper 服务器具有名为 .local
通过使用 Skipper shell,我们可以将包 zip 文件上传到 Skipper 服务器的本地仓库中,如下所示:
skipper:>package upload --path /path-to-package/mypackage-1.0.0.zip
Package uploaded successfully:[mypackage:1.0.0]
如果未设置 no,则命令将用作要上传的存储库。--repo-name
upload
local
然后,我们可以使用 or 命令查看我们的包是否已上传,如以下示例中所示(及其输出):package list
package search
skipper:>package list
╔═════════════════╤═══════╤════════════════════════════════════════════════════════════════════════════════╗
║ Name │Version│ Description ║
╠═════════════════╪═══════╪════════════════════════════════════════════════════════════════════════════════╣
║helloworld │1.0.0 │The app has two endpoints, /about and /greeting in English. Maven resource. ║
║helloworld │1.0.1 │The app has two endpoints, /about and /greeting in Portuguese. Maven resource. ║
║helloworld-docker│1.0.0 │The app has two endpoints, /about and /greeting in English. Docker resource. ║
║helloworld-docker│1.0.1 │The app has two endpoints, /about and /greeting in Portuguese. Docker resource.║
║mypackage │1.0.0 │This is a mypackage sample ║
╚═════════════════╧═══════╧════════════════════════════════════════════════════════════════════════════════╝
14.6. 创建您自己的软件包
在本节中,我们将创建一个可以使用 Spring Cloud Deployer 实现进行部署的包。
对于此包,我们将创建一个简单的包并将其上传到我们的本地计算机。
要开始创建自己的包,请按照 的命名约定创建一个文件夹。在我们的例子中,文件夹名称为 .
在此目录中,创建名为 and 的空文件,并创建一个目录。
在该目录中,创建一个名为 .[package-name]-[package-version]
demo-1.0.0
values.yml
package.yml
templates
templates
template.yml
进入我们要指定包元数据的位置。对于此应用程序,我们只填充可能的最小值,如以下示例所示:package.yml
# package.yml apiVersion: skipper.spring.io/v1 kind: SkipperPackageMetadata name: demo version: 1.0.0 description: Greets the world!
确保 and 与文件夹名称中的 和 匹配,否则会出现错误。name version name version |
接下来,打开您的文件。
在这里,我们将指定有关您的包的实际信息,最重要的是,设置默认值。
在 中,复制前面示例中的 kind 的模板。
生成的文件应类似于以下内容:templates/template.yml
template.yml
SpringCloudDeployerApplication
template.yml
# templates/template.yml apiVersion: skipper.spring.io/v1 kind: SpringCloudDeployerApplication metadata: name: demo spec: resource: maven://org.springframework.cloud.samples:spring-cloud-skipper-samples-helloworld version: {{version}} applicationProperties: {{#spec.applicationProperties.entrySet}} {{key}}: {{value}} {{/spec.applicationProperties.entrySet}} deploymentProperties: {{#spec.deploymentProperties.entrySet}} {{key}}: {{value}} {{/spec.deploymentProperties.entrySet}}
前面的示例文件指定我们的应用程序名称为 ,并在 Maven 中找到我们的包。
现在我们可以在 中指定 、 和 ,如下所示:demo
version
applicationProperties
deploymentProperties
values.yml
# values.yml # This is a YAML-formatted file. # Declare variables to be passed into your templates version: 1.0.0.RELEASE spec: applicationProperties: server.port: 8100
前面的示例将 to 设置为 ,并将 as 设置为 应用程序属性之一。
当 Skipper Package 读取器通过合并模板来解析这些值时,解析的值类似于以下内容:version
1.0.0.RELEASE
server.port=8100
values.yml
# hypothetical template.yml apiVersion: skipper.spring.io/v1 kind: SpringCloudDeployerApplication metadata: name: demo spec: resource: maven://org.springframework.cloud.samples:spring-cloud-skipper-samples-helloworld version: 1.0.0.RELEASE applicationProperties: server.port: 8100 deploymentProperties:
使用而不是直接输入值的原因是,它允许您在运行时使用 or 标志覆盖值。values.yml
--file
--properties
我们已经完成了文件制作。
现在我们必须把它拉上拉链。
最简单的方法是使用命令行上的命令,如下所示:zip -r
$ zip -r demo-1.0.0.zip demo-1.0.0/ adding: demo-1.0.0/ (stored 0%) adding: demo-1.0.0/package.yml (deflated 14%) adding: demo-1.0.0/templates/ (stored 0%) adding: demo-1.0.0/templates/template.yml (deflated 55%) adding: demo-1.0.0/values.yml (deflated 4%)
有了我们的压缩文件及其路径,我们可以前往 Skipper 并使用命令,如下所示:upload
skipper:>package upload --path /Users/path-to-your-zip/demo-1.0.0.zip Package uploaded successfully:[demo:1.0.0]
现在,您可以按前面所示搜索它,然后安装它,如下所示
skipper:>package install --package-name demo --package-version 1.0.0 --release-name demo Released demo. Now at version v1.
祝贺!您现在已经创建、打包、上传和安装了自己的 Skipper 包!
15. 存储库
存储库存储包元数据和托管包.zip文件。 存储库可以是本地的或远程的,本地是指由 Skipper 的关系数据库支持,远程是指通过 HTTP 公开的文件系统。
注册远程注册表(例如,除了名为 local' 的注册表外,当前未默认定义的注册表)时,请使用以下格式:experimental
spring cloud: skipper: server: package-repositories: experimental: url: https://skipper-repository.cfapps.io/repository/experimental description: Experimental Skipper Repository repoOrder: 0 local: url: http://${spring.cloud.client.hostname}:7577 local: true description: Default local database backed repository repoOrder: 1
对于 Skipper 2.x,结构已从列表更改为映射,其中 key 是存储库名称。使用 map 格式可以更轻松地定义和覆盖配置值。spring.cloud.skipper.server.package-repositories |
如果在两个或多个存储库中注册了具有相同名称的软件包,则 将确定哪个存储库提供软件包。repoOrder
远程存储库假定的目录结构是注册值,后跟包名称,然后是 zip 文件名(例如,对于版本为 的包)。
名为 的文件应直接位于 registered 的 — 例如 skipper-repository.cfapps.io/repository/experimental/index.yml。
此文件包含存储库托管的所有包的包元数据。url
skipper-repository.cfapps.io/repository/experimental/helloworld/helloworld-1.0.0.zip
helloworld
1.0.0
index.yml
url
由您来 “手动 ”更新远程仓库的文件。index.yml
“本地”存储库由 Skipper 的数据库提供支持。 在 Skipper 1.0 版本中,它们不会像远程存储库那样在类似文件系统的 URL 结构下公开 index.yml 或 .zip 文件。 此功能将在下一个版本中提供。 但是,您可以将包上传到本地存储库,并且不需要维护索引文件。 有关创建本地存储库的信息,请参阅“Skipper 命令”部分。
可以在此处找到一个很好的示例,该示例显示了使用具有静态资源的 Spring Boot Web 应用程序来托管存储库。 此应用程序当前在 skipper-repository.cfapps.io/repository/experimental 下运行。