From 9ec79e33e624afd3ff08f4c7719e5078a6701e7d Mon Sep 17 00:00:00 2001 From: Sangbum Kim Date: Tue, 4 Mar 2025 22:38:52 +0900 Subject: [PATCH] =?UTF-8?q?readme=20=EC=A0=95=EB=A6=AC.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Dockerfile | 2 +- LICENSE | 22 ++++++++++++++++++++++ README.md | 29 +++++++++++++++++++++++++++-- 3 files changed, 50 insertions(+), 3 deletions(-) create mode 100755 LICENSE diff --git a/Dockerfile b/Dockerfile index 8f9dcd8..0d2a1b8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,7 +4,7 @@ ## Build ## FROM rust:alpine AS build -LABEL org.opencontainers.image.authors="Sangbum Kim " +LABEL org.opencontainers.image.authors="Sangbum Kim " # set the workdir and copy the source into it WORKDIR /app diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..3b1e374 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +The BSD 3-Clause License + +Copyright (c) 2025 Sangbum Kim. +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided +that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions + and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and + the following disclaimer in the documentation and/or other materials provided with the distribution. +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or + promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF +THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index a90a92e..265e4b8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -# kwd +# kwd [![Crates.io][crates-badge]][crates-url] [![hub.docker.com][docker-badge]][docker-url] [![MIT licensed][mit-badge]][mit-url] + +[crates-badge]: https://img.shields.io/crates/v/kwd.svg +[crates-url]: https://crates.io/crates/kwd +[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg +[mit-url]: https://github.com/spi-ca/kwd/blob/main/LICENSE +[docker-badge]: https://img.shields.io/docker/v/sangbumkim/kwd +[docker-url]: https://hub.docker.com/r/sangbumkim/kwd + +## Description + +This is a tool that performs destination tasks when attaching multiple tags to a single kaniko image build. + + +## Configuration + +kwd is basically a binary wrapper for kaniko. + +When running kwd, it reads the environment variables specified below and passes the corresponding arguments to kaniko. +If execution arguments are given to kwd, these are passed transparently to the kaniko process. + +| Environment variables | Default Value | Description | +|------------------------------------|----------------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `KANIKO_BIN` | `/kaniko/executor` | Specifies the path to `kaniko` binary. By default, the path used by `gcr.io/kaniko-project/executor` is used. | +| `KANIKO_IMAGE_REPOSITORY` | | Enable TLS or not. Delete the `ssl-redirect` annotations in `expose.ingress.annotations` when TLS is disabled and `expose.type` is `ingress`. Note: if the `expose.type` is `ingress` and TLS is disabled, the port must be included in the command when pulling/pushing images. Refer to https://github.com/goharbor/harbor/issues/5291 for details. | +| `KANIKO_IMAGE_NAME` | | The source of the TLS certificate. Set as `auto`, `secret` or `none` and fill the information in the corresponding section: 1) auto: generate the TLS certificate automatically 2) secret: read the TLS certificate from the specified secret. The TLS certificate can be generated manually or by cert manager 3) none: configure no TLS certificate for the ingress. If the default TLS certificate is configured in the ingress controller, choose this option| +| `KANIKO_IMAGE_TAGS` | | The common name used to generate the certificate, it's necessary when the type isn't `ingress` | -하나의 kaniko 이미지 빌드에 여러 tag를 붙일 때 destination작업을 진행 해 주는 툴 입니다. \ No newline at end of file