Setting up a new workstation is easy. The only software required (docker, curl, git) is part of most linux distributions.
Logged in with your regular user account (not root), open a terminal and execute:
sudo apt-get update && sudo apt-get install -y docker.io curl git sshsudo gpasswd -a $USER dockergit config --global user.name "John Doe"git config --global user.email "johndoe@example.com"git config --global credential.helper storemkdir -p $HOME/Projectsssh-keygen -t ed25519 && cat $HOME/.ssh/id_ed25519.pub
The last command will print your public ssh key:
infracamp.orgssh-ed25519 AAA..............some..more..chars...........J3jAPTge jondoe@example
Copy-n-paste the whole line and add it to your favorite development platform:
Finally install your favorite IDE. Logout and login again (to have changed user permissions applied). That’s it.
By using containers not only for deployment but also for development, there is no need to install libraries on your workstation. Nor do you have to care about version conflicts, environments, paths, etc.
No more buggy project setup documentation. git clone the project and run ./kickstart.sh. Everything else is done
Change to your Projects-directory cd ~/Projects and clone infracamp’s demo project: git clone https://github.com/infracamp/kickstart-demo.git. Change to the demo project directory cd kickstart-demo and run ./kickstart.sh.
After the container was downloaded and startet, you’ll see the bash prompt inside the container. You
can use git, ssh, bash history like you do in your local shell. The project-directory is mounted
to /opt inside the container:
Open http://localhost:4300 in your browser.
What happened?
kickstart.sh evaluated the container configuration file .kick.yml
and runs the container infracamp/kickstart-flavor-gaia specified in the from section.
The container is running in development-mode: debugger, and other developer stuff is enabled.
The current project directory is mounted to /opt directory inside the container and
user rights are adjusted to your local user rights. Environment variables are adjusted.
Inside the container, the starter script kick evaluates .kick.yml and runs the
commands to install required stuff and setup the container.
To exit the container just type exit.
The .kick.yml file is the central configuration file for the container. It specifies the docker image to start. And is responsible for configuring the container. Inside the container it is evaluated by the kick command.
.kick.yml defines commands to be executed at build, dev, production and test time. You can run these commands by running kick [command]. This has the advantage to test your scripts incremental inside the container instead of rebuilding your container over and over again.
version: 1
from: infracamp/kickstart-flavor-bare:1.0
ports: "80:80/tcp;4000:4000/tcp;4100:4100/tcp"
command:
build:
- "sudo apt-get update && sudo apt-get install -y some packages"
- "composer update"
- "npm install"
- "npm build"
dev:
- npm build --watch
run:
test:
- phpunit
Inside the container you can now execute e.g. the tests with kick test.
Keeping the container configuration inside .kick.yml helps reducing your Dockerfile to only a few lines:
FROM infracamp/kickstart-flavor-base:testing
ENV DEV_CONTAINER_NAME="your-project-name"
ADD / /opt
RUN ["bash", "-c", "chown -R user /opt"]
RUN ["/kickstart/flavorkit/scripts/start.sh", "build"]
ENTRYPOINT ["/kickstart/flavorkit/scripts/start.sh", "standalone"]
Make sure to adjust FROM and DEV_CONTAINER_NAME to the settings in
.kick.yml
This example shows how to integrate in .gitlab-cl.yml:
image: docker:stable
stages:
- build
services:
- docker:dind
before_script:
- apk update && apk add bash curl
latest:
stage: build
script:
- ./kickstart.sh :test
- ./kickstart.sh ci-build
only:
- master
This will execute the unit-tests defined in command > test-section and then build the container running command > build</kdb> command.
The command kickstart.sh ci-build will build the container using Dockerfile and push the newly created container to gitlab’s registry.