Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.37 KB

setup.md

File metadata and controls

79 lines (56 loc) · 2.37 KB

Setup

Minimum requirements

  • Container management software (e.g. docker).
  • Local directory must exist to map your configuration.
  • Internet access to download the container.

1. Get the container

Pull the YaK Core container registry.gitlab.com/yak4all/yak:stable to your workstation:

sudo docker pull registry.gitlab.com/yak4all/yak:stable

FYI : The YaK Core container will including the pulling from the Yak Env Container registry.gitlab.com/yak4all/yakenv:stable
This container contains all necessary software used by YaK Core

Here are more details about the used dockerfile

2. Run the container

Execute the below script which will create

  • The required local persistant directories
  • The container run script
  • An alias "yak" to execute your container
export MY_LOCAL_YAK_DIR=${HOME}/yak 
mkdir -p  $MY_LOCAL_YAK_DIR

cat << EOF > $MY_LOCAL_YAK_DIR/yak.sh

export MY_LOCAL_YAK_DIR=${HOME}/yak 
mkdir -p  \$MY_LOCAL_YAK_DIR

export MY_LOCAL_INFRASTRUCTURE_DIR=\${MY_LOCAL_YAK_DIR}/infrastructure
export MY_LOCAL_COMPONENTS_DIR=\${MY_LOCAL_YAK_DIR}/components
export MY_LOCAL_COMPONENT_TYPES_DIR=\${MY_LOCAL_YAK_DIR}/component_types

echo  "my dir is : \$MY_LOCAL_INFRASTRUCTURE_DIR"

mkdir -p \$MY_LOCAL_INFRASTRUCTURE_DIR
mkdir -p \$MY_LOCAL_COMPONENTS_DIR
mkdir -p \$MY_LOCAL_COMPONENT_TYPES_DIR

sudo docker run -it --rm --name yak --pull always \\
           -v \${MY_LOCAL_INFRASTRUCTURE_DIR}:/workspace/yak/configuration/infrastructure \\
           -v \${MY_LOCAL_COMPONENTS_DIR}:/workspace/yak/configuration/components \\
           -v \${MY_LOCAL_COMPONENT_TYPES_DIR}:/workspace/yak/component_types \\
           -e YAK_DEV_UID=$(id -u) -e YAK_DEV_GID=$(id -g) \\
           registry.gitlab.com/yak4all/yak:stable bash
EOF

chmod +x $MY_LOCAL_YAK_DIR/yak.sh
alias yak=$MY_LOCAL_YAK_DIR/yak.sh
echo "alias yak=$MY_LOCAL_YAK_DIR/yak.sh" >> $HOME/.bash_profile

Execute your "yak" alias and if it worked well, you should be inside the container with the YaK Software configured.

$ yak 
yak@d47a98f30c99:~/yak$ ansible-inventory --graph
@all:
  |--@infrastructures:
  |--@ungrouped:
yak@d47a98f30c99:~/yak$

3. Appendix

You want to allow sudo as user ROOT in the container, the parameter below must be added in the "docker run" command

-e YAK_ENABLE_SUDO=true