jki

README

jki - JiKe Image utils

Table of Contents

• 0. Features
• 1. 安装最新版本
• 2. 使用方法
  • 2.1. 生成配置
    • 2.1.1 保存默认配置
    • 2.1.2 修改配置
    • 2.1.3 查看配置
    • 2.1.4 检查配置正确性
  • 2.2 检查更新
  • 2.3 构建镜像
  • 2.4 部署镜像
  • 2.5 跨云服务商复制镜像
  • 2.6 拉取镜像
  • 2.7 自动替换修复 deployment 不能访问的镜像

0. Features

1. 构建 Docker image（当 Docker daemon 支持 buildkit 的时候自动启用 buildkit）并方便地 push 到不同的云厂商 registry 上
2. 在不同的云厂商 registry 间复制 image
3. 方便地更新 Deployment/StatefulSet/DaemonSet/CronJob 的 image
4. 自动替换修复 Deployment 不能访问的镜像

1. 安装最新版本

curl -s https://api.github.com/repos/iftechio/jki/releases/latest \
  | grep browser_download_url \
  | grep darwin \
  | cut -d '"' -f 4 \
  | wget -i -

tar --strip-components=1 -xf jki*

sudo cp jki /usr/local/bin/

2. 使用方法

2.1. 生成配置

2.1.1 保存默认配置

$ jki config init --save

2.1.2 修改配置

$ jki config edit

2.1.3 查看配置

$ jki config view
default-registry: ali
registries:
- name: ali
  aliyun:
    # 如果使用 access key 的话这里就不用设置
    # 用户名、密码请用子账号访问 https://cr.console.aliyun.com/cn-hangzhou/instances/credentials 获取
    #username: <YOUR USERNAME>
    #password: <YOUR PASSWORD>

    # 使用子账号登录后访问 https://usercenter.console.aliyun.com/#/manage/ak 创建自己的 access key
    # 如果出现 user not exist 错误, 需要到 https://cr.console.aliyun.com 开通服务
    access_key: <YOUR ACCESS KEY ID>
    secret_access_key: <YOUR ACCESS KEY SECRET>

    # 这个 namespace 指的是容器镜像服务里的命名空间
    # 可以到 https://cr.console.aliyun.com/cn-hangzhou/instances/namespaces 查看
    namespace: <REGISTRY NAMESPACE>
# 阿里云企业版    
- name: ali-ee
  aliyun_ee:
    access_key: 123
    secret_access_key: 456
    namespace: test
    region: cn-hangzhou
    # 企业实例id
    instance_id: cri-123456
    # optional 企业版可自己配host
    # 如果不填将从 aliyun 的 api 取host, 需要提供access_key, secret_access_key
    #instance_host: abc-registry.cn-hangzhou.cr.aliyuncs.com
- name: aws-tokyo
  aws:
    access_key: <YOUR ACCESS KEY>
    secret_access_key: <YOUR SECRET ACCESS KEY>
    region: ap-northeast-1
    account_id: <YOUR ACCOUNT ID> # 注意填写的 account id 两边要有双引号
- name: mine
  dockerhub:
    username: foo
    password: bar

2.1.4 检查配置正确性

$ jki config check

如果配置语法没问题的话会打印 OK!

2.2 检查更新

$ jki upgrade

注：如果是通过 homebrew 安装的请通过 homebrew 更新

2.3 构建镜像

默认情况下会把构建出来的镜像推送到配置里指定的 default-registry

$ jki build

指定 Dockerfile 路径:

$ jki build -f <YOUR Dockerfile>

指定构建目录:

$ jki build <YOUR DIR>

指定镜像的名字:

$ jki build --image-name <IMAGE NAME>

指定要推送的 registry (以上面的配置为例):

$ jki build --registry aws-tokyo

更多选项可以参考 jki build -h

2.4 部署镜像

注： 默认情况下，jki 会以 Deployment 为目标资源，并且把镜像的名字当作目标资源的名字。

目前只支持 Pod、Deployment、StatefulSet、DaemonSet、CronJob 这几种资源，如果 Pod 内有多个 Container 的话，必须通过 -c 参数指定 Container 的名字。

只指定镜像:

# 会更新默认 namespace 下名为 `nginx` 的 Deployment 里的 image 为 `nginx:alpine`
$ jki deploy nginx:alpine

指定镜像跟 Resource:

# 会更新 foo namespace 下名为 `nginx` 的 StatefulSet 里的 image 为 `nginx:alpine`
$ jki deploy -n foo sts nginx:alpine

指定名字跟 Resource:

# 会更新默认 namespace 下名为 `bar` 的 Deployment 里的名为 `app` 的 container 的 image 为 `nginx:alpine`
$ jki deploy -c app bar nginx:alpine

指定镜像、名字跟 Resource:

# 会更新默认 namespace 下名为 `foo` 的 DaemonSet 里的 image 为 `nginx:alpine`
$ jki deploy ds/foo nginx:alpine

2.5 跨云服务商复制镜像

以上面的配置为例

# 会把 `<YOUR ACCOUNT ID>.dkr.ecr.ap-northeast-1.amazonaws.com/foo:bar` 该镜像复制到 `ali` 对应的 registry 上
$ jki cp <YOUR ACCOUNT ID>.dkr.ecr.ap-northeast-1.amazonaws.com/foo:bar

指定目标 registry:

# 会把 `k8s.gcr.io/etcd:3.3.10` 该镜像复制到 `aws-tokyo` 对应的 registry 上
$ jki cp k8s.gcr.io/etcd:3.3.10 aws-tokyo

自动复制最新的 tag (仅限于 AWS ECR 跟阿里云容器镜像服务):

# 会查询 `<YOUR ACCOUNT ID>.dkr.ecr.ap-northeast-1.amazonaws.com/foo` 该 image 最新的 tag
# 然后复制到 `ali` 对应的 registry
$ jki cp <YOUR ACCOUNT ID>.dkr.ecr.ap-northeast-1.amazonaws.com/foo

2.6 拉取镜像

$ jki pull <YOUR ACCOUNT ID>.dkr.ecr.ap-northeast-1.amazonaws.com/foo:bar

2.7 自动替换修复 deployment 不能访问的镜像

执行命令后会逐个提示替换无法现在的镜像

$ jki transferimage --namespace default
Transfer Deployment/foo1 gcr.io/foo1:bar(y/n)?
>y
Transfer gcr.io/foo1:bar to xxx.dkr.ecr.ap-northeast-1.amazonaws.com/foo1:bar