Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 1.89 KB

contribution.md

File metadata and controls

65 lines (46 loc) · 1.89 KB

Contribution

Requirements

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

Setup

  1. pull the Yak Core container registry.gitlab.com/yak4all/yak:stable to your workstation
docker pull registry.gitlab.com/yak4all/yak:latest

FYI : The YaK Core container will pull the Yak Env docker container image from GitLab container registry registry.gitlab.com/yak4all/yakenv:1.0.0
This container contains all necessary softwares used by YaK Core
see here for more information : https://gitlab.com/yak4all/yakenv/-/blob/main/Dockerfile

  1. Define an environment variable ${MY_LOCAL_YAK_DIR} as GiT checkout folder

The Yak GiT reposistory needs to be cloned locally in order to be mounted later as a persistent volume within the container

export MY_LOCAL_YAK_DIR=$HOME/GIT/yak
  1. Clone the YaK repository in your $HOME directory
cd $HOME/GIT
git clone [email protected]:yak4all/yak.git
  1. Start the container with the below command
docker run -it --rm -e YAK_ENABLE_SUDO=true --name yak --pull always -v ${HOME}/.ssh:/workspace/.ssh -v ${MY_LOCAL_YAK_DIR}:/workspace/yak registry.gitlab.com/yak4all/yak:latest bash

If it works you should be inside the container with the YaK repository available for contribution

docker run -it --rm -e YAK_ENABLE_SUDO=true --name yak --pull always -v ${HOME}/.ssh:/workspace/.ssh -v ${MY_LOCAL_YAK_DIR}:/workspace/yak registry.gitlab.com/yak4all/yak:latest bash

INFO: type 'yakhelp' to display the help of YaK

yak@d915a92de516:~/yak$ aig
@all:
  |--@demo_aws:
  |  |--demo_aws/linux
  |  |--demo_aws/linux/ORA
  |--@oracle_instance:
  |  |--demo_aws/linux/ORA
  |--@servers:
  |  |--demo_aws/linux
  |--@ungrouped:
yak@d915a92de516:~/yak

License

GNU General Public License v3.0 or later See COPYING to see the full text.