org.dromara.jpom.DockerUtil Maven / Gradle / Ivy
/*
* The MIT License (MIT)
*
* Copyright (c) 2019 Code Technology Studio
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.dromara.jpom;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.io.FileUtil;
import cn.hutool.core.io.IoUtil;
import cn.hutool.core.lang.Opt;
import cn.hutool.core.map.MapUtil;
import cn.hutool.core.util.StrUtil;
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONFactory;
import com.alibaba.fastjson2.JSONObject;
import com.alibaba.fastjson2.JSONWriter;
import com.github.dockerjava.api.DockerClient;
import com.github.dockerjava.api.model.AuthConfig;
import com.github.dockerjava.api.model.AuthResponse;
import com.github.dockerjava.api.model.ResponseItem;
import com.github.dockerjava.core.DefaultDockerClientConfig;
import com.github.dockerjava.core.DockerClientConfig;
import com.github.dockerjava.core.DockerClientImpl;
import com.github.dockerjava.httpclient5.ApacheDockerHttpClient;
import com.jcraft.jsch.Session;
import lombok.extern.slf4j.Slf4j;
import org.dromara.jpom.ssh.JschDockerHttpClient;
import java.io.File;
import java.time.Duration;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Supplier;
/**
* @author bwcx_jzy
* @since 2022/1/26
*/
@Slf4j
public class DockerUtil {
static {
// 禁用 jackson
JSONFactory.setUseJacksonAnnotation(false);
// 枚举对象使用 枚举名称
JSON.config(JSONWriter.Feature.WriteEnumsUsingName);
}
private static final Map DOCKER_CLIENT_MAP = new ConcurrentHashMap<>();
private static final Map CACHE_CLOSET = new ConcurrentHashMap<>();
/**
* dockerfile 文件名称
*/
public static final String DOCKER_FILE = "Dockerfile";
/**
* 获取 docker client ，会使用缓存
*
* 如果参数包含 closeBefore 则重新创建
*
* @param parameter 参数
* @return DockerClient
*/
public static DockerClient get(Map parameter) {
String host = (String) parameter.get("dockerHost");
String dockerCertPath = (String) parameter.get("dockerCertPath");
String key = StrUtil.format("{}-{}", host, StrUtil.emptyToDefault(dockerCertPath, StrUtil.EMPTY));
if (parameter.containsKey("closeBefore")) {
// 关闭之前的连接
DockerClient dockerClient = DOCKER_CLIENT_MAP.remove(key);
IoUtil.close(dockerClient);
}
return DOCKER_CLIENT_MAP.computeIfAbsent(key, s -> create(parameter));
}
/**
* 构建 docker client 对象
*
* @param parameter 参数
* @return DockerClient
*/
private static DockerClient create(Map parameter) {
String host = (String) parameter.get("dockerHost");
String apiVersion = (String) parameter.get("apiVersion");
String dockerCertPath = (String) parameter.get("dockerCertPath");
String registryUsername = (String) parameter.get("registryUsername");
String registryPassword = (String) parameter.get("registryPassword");
String registryEmail = (String) parameter.get("registryEmail");
String registryUrl = (String) parameter.get("registryUrl");
Supplier sessionSupplier = (Supplier) parameter.get("session");
//
DefaultDockerClientConfig.Builder defaultConfigBuilder = DefaultDockerClientConfig.createDefaultConfigBuilder();
defaultConfigBuilder
.withDockerTlsVerify(StrUtil.isNotEmpty(dockerCertPath))
.withApiVersion(apiVersion)
.withDockerCertPath(dockerCertPath)
.withDockerHost(host);
//
Opt.ofBlankAble(registryUrl).ifPresent(s -> defaultConfigBuilder.withRegistryUrl(registryUrl));
Opt.ofBlankAble(registryEmail).ifPresent(s -> defaultConfigBuilder.withRegistryEmail(registryEmail));
Opt.ofBlankAble(registryUsername).ifPresent(s -> defaultConfigBuilder.withRegistryUsername(registryUsername));
Opt.ofBlankAble(registryPassword).ifPresent(s -> defaultConfigBuilder.withRegistryPassword(registryPassword));
DockerClient dockerClient;
DockerClientConfig config = defaultConfigBuilder.build();
if (sessionSupplier != null) {
// 通过SSH连接Docker
JschDockerHttpClient httpClient = new JschDockerHttpClient(config.getDockerHost(), sessionSupplier);
dockerClient = DockerClientImpl.getInstance(config, httpClient);
} else {
ApacheDockerHttpClient.Builder builder = new ApacheDockerHttpClient.Builder()
.dockerHost(config.getDockerHost())
.sslConfig(config.getSSLConfig())
.maxConnections(100);
int timeout = Convert.toInt(parameter.get("timeout"), 0);
if (timeout > 0) {
builder.connectionTimeout(Duration.ofSeconds(timeout));
builder.responseTimeout(Duration.ofSeconds(timeout));
}
ApacheDockerHttpClient httpClient = builder.build();
dockerClient = DockerClientImpl.getInstance(config, httpClient);
}
if (StrUtil.isNotEmpty(registryUrl)) {
AuthConfig authConfig = dockerClient.authConfig();
AuthResponse authResponse = dockerClient.authCmd().withAuthConfig(authConfig).exec();
log.debug("auth cmd:{}", JSONObject.toJSONString(authResponse));
}
return dockerClient;
}
/**
* 临时文件目录
*
* @param name 文件名
* @param tempDir 临时文件目录
* @return temp
*/
public static File createTemp(String name, File tempDir) {
return FileUtil.file(tempDir, name);
}
/**
* 获取进度信息
*
* @param responseItem 响应结果
* @return 转化为 字符串
*/
public static String parseResponseItem(ResponseItem responseItem) {
String stream = responseItem.getStream();
if (stream == null) {
String status = responseItem.getStatus();
if (status == null) {
Map rawValues = responseItem.getRawValues();
return MapUtil.join(rawValues, ",", "=") + StrUtil.LF;
}
String progress = responseItem.getProgress();
progress = StrUtil.emptyToDefault(progress, StrUtil.EMPTY);
String id = responseItem.getId();
id = StrUtil.emptyToDefault(id, StrUtil.EMPTY);
return StrUtil.format("{} {} {}", status, id, progress);
}
return stream;
}
/**
* 深度转换为 json object
*
* @param object 对象
* @return 转换后的
*/
public static JSONObject toJSON(Object object) {
String jsonString = JSONObject.toJSONString(object);
return (JSONObject) JSON.parse(jsonString);
}
public static void putClose(String id, AutoCloseable autoCloseable) {
AutoCloseable closeable = CACHE_CLOSET.put(id, autoCloseable);
// 关闭上一次资源
IoUtil.close(closeable);
}
public static void close(String id) {
IoUtil.close(CACHE_CLOSET.remove(id));
}
}