Elasticsearch 5.6.4 容器启动cmd解读

前段时间对基于elasticsearch-5.6.4-alpine镜像创建容器时的CMD机制作了认真的研究与实践,这里记录下研究中的收获。

elasticsearch-5.6.4-alpine镜像Dockerfile内容
FROM openjdk:8-jre-alpine

# ensure elasticsearch user exists
RUN addgroup -S elasticsearch && adduser -S -G elasticsearch elasticsearch

# grab su-exec for easy step-down from root
# and bash for "bin/elasticsearch" among others
RUN apk add --no-cache 'su-exec>=0.2' bash

# https://artifacts.elastic.co/GPG-KEY-elasticsearch
ENV GPG_KEY 46095ACC8548582C1A2699A9D27D666CD88E42B4

WORKDIR /usr/share/elasticsearch
ENV PATH /usr/share/elasticsearch/bin:$PATH

ENV ELASTICSEARCH_VERSION 5.6.10
ENV ELASTICSEARCH_TARBALL="https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.6.10.tar.gz" \
    ELASTICSEARCH_TARBALL_ASC="https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.6.10.tar.gz.asc" \
    ELASTICSEARCH_TARBALL_SHA1="c4df8b240635484f09487a66707a9192bf97d3f9"

RUN set -ex; \
    \
    apk add --no-cache --virtual .fetch-deps \
        ca-certificates \
        gnupg \
        openssl \
        tar \
    ; \
    \
    wget -O elasticsearch.tar.gz "$ELASTICSEARCH_TARBALL"; \
    \
    if [ "$ELASTICSEARCH_TARBALL_SHA1" ]; then \
        echo "$ELASTICSEARCH_TARBALL_SHA1 *elasticsearch.tar.gz" | sha1sum -c -; \
    fi; \
    \
    if [ "$ELASTICSEARCH_TARBALL_ASC" ]; then \
        wget -O elasticsearch.tar.gz.asc "$ELASTICSEARCH_TARBALL_ASC"; \
        export GNUPGHOME="$(mktemp -d)"; \
        gpg --keyserver ha.pool.sks-keyservers.net --recv-keys "$GPG_KEY"; \
        gpg --batch --verify elasticsearch.tar.gz.asc elasticsearch.tar.gz; \
        rm -rf "$GNUPGHOME" elasticsearch.tar.gz.asc; \
    fi; \
    \
    tar -xf elasticsearch.tar.gz --strip-components=1; \
    rm elasticsearch.tar.gz; \
    \
    apk del .fetch-deps; \
    \
    mkdir -p ./plugins; \
    for path in \
        ./data \
        ./logs \
        ./config \
        ./config/scripts \
    ; do \
        mkdir -p "$path"; \
        chown -R elasticsearch:elasticsearch "$path"; \
    done; \
    \
# we shouldn't need much RAM to test --version (default is 2gb, which gets Jenkins in trouble sometimes)
    export ES_JAVA_OPTS='-Xms32m -Xmx32m'; \
    if [ "${ELASTICSEARCH_VERSION%%.*}" -gt 1 ]; then \
        elasticsearch --version; \
    else \
# elasticsearch 1.x doesn't support --version
# but in 5.x, "-v" is verbose (and "-V" is --version)
        elasticsearch -v; \
    fi

COPY config ./config

VOLUME /usr/share/elasticsearch/data

COPY docker-entrypoint.sh /

EXPOSE 9200 9300
ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ["elasticsearch"]

可见Dockerfile中指定的ENTRYPOINT为/docker-entrypoint.sh

脚本docker-entrypoint.sh内容

#!/bin/bash

set -e

# Add elasticsearch as command if needed
if [ "${1:0:1}" = '-' ]; then
    set -- elasticsearch "$@"
fi

# Drop root privileges if we are running elasticsearch
# allow the container to be started with `--user`
if [ "$1" = 'elasticsearch' -a "$(id -u)" = '0' ]; then
    # Change the ownership of user-mutable directories to elasticsearch
    for path in \
        /usr/share/elasticsearch/data \
        /usr/share/elasticsearch/logs \
    ; do
        chown -R elasticsearch:elasticsearch "$path"
    done
    
    set -- su-exec elasticsearch "$@"
    #exec su-exec elasticsearch "$BASH_SOURCE" "$@"
fi

# As argument is not related to elasticsearch,
# then assume that user wants to run his own process,
# for example a `bash` shell to explore this image
exec "$@"

可见,docker-entrypoint.sh脚本支持接收参数,比如/docker-entrypoint.sh xxx

脚本docker-entrypoint.sh内容解读

set -e:设定当脚本中执行的命令的返回值不等于0(返回值不等于0,表示命名执行出错),则退出shell,比如:

1表示可执行脚本接收的第一个参数,@表示脚本接收的所有参数
{1:0:1}表示{parameter:offset:length}的操作,假设1为hello,则{1:0:1}结果为h

set -- :用来设置位置参数,执行命令set -- arg1 arg2后,$@值为 arg1 arg2,比如:

上述if语句判断当 /docker-entrypoint.sh 接收的位置参数中的第一个参数的首个字符若为'-',则会重新设置位置参数,比如/docker-entrypoint.sh --help 执行后,此时$@值则为:elasticsearch --help

id -u:显示当前系统登录的用户ID

若位置参数的第一个值为elasticsearch且当前系统登录的用户为root(root的用户ID通常为0),则将/usr/share/elasticsearch/data、/usr/share/elasticsearch/logs两个目录的所有者和组更改为elasticsearch:elasticsearch,最后设置位置参数$@的值。

su-exec:切换用户和组后执行命令,Usage: su-exec user-spec command [args]
su-exec elasticsearch "@"表示切换到elasticsearch用户执行"@"的值所代表的命令

exec:并不启动新的shell,而是用要被执行命令替换当前的shell进程,并且将老进程的环境清理掉,而且exec命令后的其它命令将不再执行。因此,如果在一个shell里面,执行exec ls那么,当列出了当前目录后,这个shell就自己退出了,因为这个shell进程已被替换为仅仅执行ls命令的一个进程,执行结束自然也就退出了。man exec信息如下:

检测脚本docker-entrypoint.sh的位置参数的变化:



Docker的ENTRYPOINT机制是当基于镜像运行容器时,ENTRYPOINT指定的执行脚本是执行的起点,CMD是作为该执行脚本的位置参数传入,比如elasticsearch:5.6.4.-alpine镜像的Dockerfile为:

ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ["elasticsearch"]

docker run xxx elasticsearch:5.6.4-alpine 本质上是执行/docker-entrypoint.sh elasticsearch
若在docker run 时执行cmd,比如docker run xxx elasticsearch:5.6.4-alpine cmds 本质上是执行/docker-entrypoint.sh cmds


实践
  1. docker run -itd --name es 192.168.84.23:5000/library/elasticsearch:5.6.4-alpine elasticsearch
    本质上等同于docker run -itd --name es 192.168.84.23:5000/library/elasticsearch:5.6.4-alpine

  2. docker run -itd --name es2 192.168.84.23:5000/library/elasticsearch:5.6.4-alpine /usr/share/elasticsearch/bin/elasticsearch

    本质上是执行了/docker-entrypoint.sh /usr/share/elasticsearch/bin/elasticsearch ,由脚本内容可知,在启动的容器中以root用户运行了elasticsearch服务,因此会报上述错误。

  3. 比如想要映射elasticsearch的config目录,则此时需要更改config目录的属主与属组信息docker run -itd --name elasticsearch -v /root/elasticsearch/config:/usr/share/elasticsearch/config 192.168.84.23:5000/library/elasticsearch:5.6.4-alpine elasticsearch && chown -R elasticsearch:elasticsearch /usr/share/elasticsearch/config 这样写的方式是不合适的,run后面的命令本来是 elasticsearch && chown -R elasticsearch:elasticsearch /usr/share/elasticsearch/config,但此时则变成了以&&作为连接符的两个shell命令了。若以这种方式执行docker run -itd --name elasticsearch -v /root/elasticsearch/config:/usr/share/elasticsearch/config 192.168.84.23:5000/library/elasticsearch:5.6.4-alpine "elasticsearch && chown -R elasticsearch:elasticsearch /usr/share/elasticsearch/config"

    报错的原因是脚本中的exec命令导致的,类似于如下错误信息
    可见加上sh -c后错误就不存在了;因此,此处最好的方式是通过sh -c来编写docker run所携带的命令。

  4. 分析docker-entrypoint.sh内容可知,该脚本中有处理机制将root用户切换到elasticsearch用户来执行elasticsearch命令,因此在sh -c "$cmd" 中,cmd最好还是以docker-entrypoint.sh为执行起点。docker run -itd --name elasticsearch -v /root/elasticsearch/config:/usr/share/elasticsearch/config 192.168.84.23:5000/library/elasticsearch:5.6.4-alpine sh -c "chown -R elasticsearch:elasticsearch /usr/share/elasticsearch/config && /docker-entrypoint.sh elasticsearch"

  • 首先更改config目录权限 chown -R elasticsearch:elasticsearch /usr/share/elasticsearch/config
  • 然后运行elasticsearch服务 /docker-entrypoint.sh elasticsearch
  1. docker run -itd --name elasticsearch -v /root/elasticsearch/config:/usr/share/elasticsearch/config -v /root/elasticsearch/data:/usr/share/elasticsearch/data -v /root/elasticsearch/logs:/usr/share/elasticsearch/logs -v /root/elasticsearch/plugins:/usr/share/elasticsearch/plugins 192.168.84.23:5000/library/elasticsearch:5.6.4-alpine sh -c "chown -R elasticsearch:elasticsearch /usr/share/elasticsearch/config /usr/share/elasticsearch/plugins && /docker-entrypoint.sh elasticsearch"
    sh -c "chown -R elasticsearch:elasticsearch /usr/share/elasticsearch/config /usr/share/elasticsearch/plugins && /docker-entrypoint.sh elasticsearch", 命令中并没有显示的为data、logs目录更改属主与属组,其实这个操作已经在docker-entrypoint.sh脚本中完成了。

结语

上述为研究的过程与记录,这里创建容器的参数配置仅是为了研究CMD的需要,在实际的使用中创建elasticsearch容器的参数则需要根据自身情况来定义;欢迎批评、指正,望与大家一起学习,进步。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,284评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,115评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,614评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,671评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,699评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,562评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,309评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,223评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,668评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,859评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,981评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,705评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,310评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,904评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,023评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,146评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,933评论 2 355

推荐阅读更多精彩内容