1
0
mirror of https://github.com/hegerdes/gitlab-actions.git synced 2025-10-06 05:36:52 +02:00
This commit is contained in:
Henrik Gerdes
2023-12-22 22:29:31 +01:00
parent 8ca2879c5f
commit c369dcec1b
4 changed files with 193 additions and 85 deletions

View File

@@ -6,8 +6,30 @@
# Note that environment variables can be set in several places
# See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence
stages:
- test
- test
- build
- release
include:
- template: Security/SAST.gitlab-ci.yml
- component: gitlab.com/$CI_PROJECT_PATH/container-build.yml@$CI_COMMIT_SHA
inputs:
force_run: true
context: $CI_PROJECT_DIR/tests
dockerfile: $CI_PROJECT_DIR/tests/Dockerfile
sast:
stage: test
include:
- template: Security/SAST.gitlab-ci.yml
# If we are tagging a release with a specific convention ("v" + number) and all
# previous checks succeeded, we proceed with creating a release automatically.
create-release:
stage: release
image: registry.gitlab.com/gitlab-org/release-cli:latest
rules:
- if: $CI_COMMIT_TAG =~ /\d+/
script: echo "Creating release $CI_COMMIT_TAG"
release:
tag_name: $CI_COMMIT_TAG
description: "Release $CI_COMMIT_TAG of components repository $CI_PROJECT_PATH"

113
README.md
View File

@@ -1,93 +1,42 @@
# Container Build Kaniko
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.com/hegerdes/container-build-kaniko.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.com/hegerdes/container-build-kaniko/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Use this component to enable container scanning in your project.
You should add this component to an existing `.gitlab-ci.yml` file by using the `include:`
keyword.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
```yaml
include:
- component: gitlab.com/hegerdes/container-build-kaniko/container-build@<VERSION>
```
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
where `<VERSION>` is the latest released tag or `main`.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
This will add a `container_scanning` job to the pipeline.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
The template should work without modifications but you can customize the template settings.
### Inputs
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
| Input | Default value | Description |
| ----- | ------------- | ----------- |
| `stage` | `test` | The stage where you want the job to be added |
| `analyzer_image` | `$CI_TEMPLATE_REGISTRY_HOST/security-products/container-scanning:5` | The Docker image of the analyzer |
| `force_run` | `false` | When set to `true` it always adds the job even if `$CONTAINER_SCANNING_DISABLED` is set |
## License
For open source projects, say how it is licensed.
### Variables
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
| Variable | Description |
| -------- | ----------- |
| `GIT_STRATEGY` | Default to `fetch`. |
| `DOCKER_AUTH_CONFIG ` | GitLab variable containing registry secrets. |
For details, see the following links:
- https://docs.gitlab.com/ee/user/application_security/container_scanning/index.html#overriding-the-container-scanning-template
- https://docs.gitlab.com/ee/user/application_security/container_scanning/#vulnerability-allowlisting
- List of available variables: https://docs.gitlab.com/ee/user/application_security/container_scanning/#available-variables
## Contribute
Please read about CI/CD components and best practices at: https://docs.gitlab.com/ee/ci/components

View File

@@ -0,0 +1,131 @@
spec:
inputs:
stage:
default: test
build_image:
default: gcr.io/kaniko-project/executor:debug
force_run:
type: boolean
default: false
push:
type: boolean
default: true
kaniko_use_cache:
type: boolean
default: false
image_tag:
default: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME
context:
default: $CI_PROJECT_DIR
dockerfile:
default: $CI_PROJECT_DIR/Dockerfile
authors:
default: $CI_COMMIT_AUTHOR
source_url:
default: $CI_PROJECT_URL
project_url:
default: $CI_PROJECT_URL
version:
default: $CI_COMMIT_REF_NAME
dokumentation_url:
default: $CI_PROJECT_URL
description:
default: $CI_PROJECT_DESCRIPTION
base_img_name:
default: UNKNOWN
vendor:
default: UNKNOWN
license:
default: UNKNOWN
---
container_build:
stage: $[[ inputs.stage ]]
image:
name: "$[[ inputs.analyzer_image ]]"
entrypoint: [""]
variables:
#More Information on Kaniko Caching: https://cloud.google.com/build/docs/kaniko-cache\n\t
#Set to 2 weeks
KANIKO_DEFAULT_CACHE_ARGS: --cache=true --cache-copy-layers=false --cache-ttl=336h
KANIKO_PUSH: "$[[ inputs.push ]]"
KANIKO_USE_CACHE: "$[[ inputs.kaniko_use_cache ]]"
BUILD_IMAGE_TAG: "$[[ inputs.image_tag ]]"
CONTEXT: "$[[ inputs.context ]]"
DOCKERFILE: "$[[ inputs.dockerfile ]]"
AUTHORS: "$[[ inputs.authors ]]"
SOURCE_URL: "$[[ inputs.source_url ]]"
PROJECT_URL: "$[[ inputs.project_url ]]"
VERSION: "$[[ inputs.version ]]"
DOKUMENTATION_URL: "$[[ inputs.dokumentation_url ]]"
DESCRIPTION: "$[[ inputs.description ]]"
VENDOR: "$[[ inputs.vendor ]]"
LICENSE: "$[[ inputs.license ]]"
BASE_IMG_NAME: "$[[ inputs.base_img_name ]]"
script:
- echo "Using kaniko $(/kaniko/executor version)"
- |
echo "Setting up job..." > /dev/null
if [ ! -z ${KANIKO_EXTRA_ARGS+x} ]; then KANIKO_EXTRA_ARGS_INTERNAL="${KANIKO_EXTRA_ARGS}"; fi
mkdir -p /kaniko/.docker && mkdir build-artifacts
- |
echo "Setting variables" > /dev/null
if [ "${KANIKO_USE_CACHE}" = "true" ]; then export KANIKO_CACHE_ARGS=$KANIKO_DEFAULT_CACHE_ARGS; fi
if [ "${KANIKO_PUSH}" = false" ]; then export KANIKO_EXTRA_ARGS_INTERNAL="--no-push ${KANIKO_EXTRA_ARGS_INTERNAL}"; fi
if [ ! -z ${KANIKO_EXTRA_BUILD_DST+x} ]; then KANIKO_EXTRA_ARGS_INTERNAL="--destination ${KANIKO_EXTRA_BUILD_DST} ${KANIKO_EXTRA_ARGS_INTERNAL}"; fi
echo "Building ${BUILD_IMAGE_TAG}..."
echo "Using context \"${CONTEXT}\" with dockerfile \"${DOCKERFILE}\""
- |
echo "Building image with kaniko..."
if [ ! -z ${KANIKO_EXTRA_ARGS_INTERNAL+x} ]; then echo "Using extra build-args=${KANIKO_EXTRA_ARGS_INTERNAL}"; fi
/kaniko/executor \
--context $CONTEXT \
--skip-unused-stages \
--log-timestamp=true \
--registry-mirror mirror.gcr.io \
--dockerfile $DOCKERFILE $KANIKO_CACHE_ARGS \
--build-arg COMMIT_HASH=$CI_COMMIT_SHORT_SHA \
--build-arg COMMIT_TAG=$CI_COMMIT_REF_NAME \
--build-arg BUILD_ENV=$BUILD_ENV \
--label org.opencontainers.image.created="$(date -D FMT=minutes)" \
--label org.opencontainers.image.authors="${AUTHORS}" \
--label org.opencontainers.image.url="${PROJECT_URL}" \
--label org.opencontainers.image.documentation="${DOKUMENTATION_URL}" \
--label org.opencontainers.image.source="${SOURCE_URL}" \
--label org.opencontainers.image.version="${VERSION}" \
--label org.opencontainers.image.revision="${CI_COMMIT_SHORT_SHA}" \
--label org.opencontainers.image.vendor="${VENDOR}" \
--label org.opencontainers.image.licenses="${LICENSE}" \
--label org.opencontainers.image.title="$BUILD_IMAGE_TAG" \
--label org.opencontainers.image.description="$DESCRIPTION" \
--label org.opencontainers.image.base.name="${BASE_IMG_NAME}" \
--destination $BUILD_IMAGE_TAG $KANIKO_EXTRA_ARGS_INTERNAL
artifacts:
name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME"
paths:
- build-artifacts/**
expire_in: 1 week
when: always
rules:
- if: '"$[[ inputs.force_run ]]" == "false"' # && ($CONTAINER_SCANNING_DISABLED == "true" || $CONTAINER_SCANNING_DISABLED == "1")'
when: never
# Add the job to merge request pipelines if there's an open merge request.
- if: '$CI_PIPELINE_SOURCE == "merge_request_event" &&
$CI_GITLAB_FIPS_MODE == "true" &&
"$[[ inputs.analyzer_image ]]" !~ /-(fips|ubi)\z/'
variables:
CS_IMAGE_SUFFIX: -fips
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
# Don't add it to a *branch* pipeline if it's already in a merge request pipeline.
- if: $CI_OPEN_MERGE_REQUESTS
when: never
# Add the job to branch pipelines.
- if: '$CI_COMMIT_BRANCH &&
$CI_GITLAB_FIPS_MODE == "true" &&
"$[[ inputs.analyzer_image ]]" !~ /-(fips|ubi)\z/'
variables:
CS_IMAGE_SUFFIX: -fips
- if: $CI_COMMIT_BRANCH

6
tests/Dockerfile Normal file
View File

@@ -0,0 +1,6 @@
FROM alpine
RUN apk add bash
WORKDIR /workspace
COPY . /workspace/