From 314e238be5ee3b3c288f7d6a2141d73fa7b789d5 Mon Sep 17 00:00:00 2001 From: Ruan Bekker Date: Sun, 19 Jun 2022 11:20:16 +0200 Subject: [PATCH] Add screenshots and project structure --- README.md | 122 ++++++++++++++++++++++++ README_VSCODE.md | 29 ++++++ Vagrantfile | 5 +- ansible/playbook-no-roles.yml | 15 +++ ansible/roles/main/defaults/main.yml | 1 - ansible/roles/main/tasks/main.yml | 8 -- ansible/roles/website/defaults/main.yml | 4 +- 7 files changed, 171 insertions(+), 13 deletions(-) create mode 100644 README_VSCODE.md create mode 100644 ansible/playbook-no-roles.yml delete mode 100644 ansible/roles/main/defaults/main.yml delete mode 100644 ansible/roles/main/tasks/main.yml diff --git a/README.md b/README.md index 9f2a67a..6865e21 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,124 @@ # dev-environment-vagrant Developer Environment with Vagrant, Docker and Ansible + +## What does this provide + +Spin up linux development environments quickly that offers the following: +- run shell commands (installing dependencies as an example) +- use the docker provisioner if you want to make use of docker containers in your environment +- use the ansible provisioner if you want to make use of ansible playbooks to prepare your environment +- remote development on vscode + +I have included a example of the shell, docker and ansible provisioner. + +## Usage + +Clone the repo and change to the directory: + +```bash +git clone https://github.com/ruanbekker/dev-environment-vagrant +cd dev-environment-vagrant +``` + +Install vagrant by following their [installation documentation](https://www.vagrantup.com/docs/installation), then boot the environment using: + +```bash +vagrant up +``` + +In this example we are using 3 provisioners for demonstration: +- shell provisioner (runs shell commands on provisioning) +- docker provisioner (runs a docker container on provisioning) +- ansible provisioner (runs a ansible playbook on provisioning) + +Once the vm is booted, we can get the status: + +```bash +vagrant status +``` + +We can ssh directly to the vm, using: + +``` +vagrant ssh +``` + +If we want to use VSCode for remote development, you can install the [Remote-SSH](https://code.visualstudio.com/docs/remote/ssh) extension if you don't have it already, then you can view the ssh config of your vm using: + +``` +vagrant ssh-config +``` + +To make things easier, we can then append the ssh config to your `~/.ssh/config` file, then we can ssh to our vm using: + +``` +ssh sektor +``` + +Or use VSCode for Remote Development, to see the instructions and screenshots, see the [VSCode Readme](README_VSCODE.md). + +When making changes to your provisioner or ansible playbooks, then you can simply run: + +``` +vagrant provision +``` + +To destroy your environment: + +``` +vagrant destroy +``` + +## Project Structure + +The procject structure: + +```bash +. +├── README.md +├── README_VSCODE.md +├── Vagrantfile +└── ansible + ├── inventory + ├── playbook-no-roles.yml + ├── playbook.yml + └── roles + └── website + ├── README.md + ├── defaults + │ └── main.yml + ├── files + │ └── styles.css + ├── handlers + │ └── main.yml + ├── meta + │ └── main.yml + ├── tasks + │ ├── configuration.yml + │ ├── main.yml + │ └── setup-ubuntu.yml + ├── templates + │ ├── app.conf.j2 + │ ├── index.html.j2 + │ └── nginx.conf.j2 + ├── tests + │ ├── inventory + │ └── test.yml + └── vars + └── main.yml + +11 directories, 20 files +``` + +## Example Applications + +The deployed docker container can be accessed on: +- http://http://192.168.33.23:8080 + +The deployed website via ansible can be accessed on: +- http://192.168.33.23:8080/ + +## Resources + +- https://github.com/AntonyLeons/Ward +- https://hub.docker.com/r/imightbebob/linux-dash \ No newline at end of file diff --git a/README_VSCODE.md b/README_VSCODE.md new file mode 100644 index 0000000..b184156 --- /dev/null +++ b/README_VSCODE.md @@ -0,0 +1,29 @@ +# dev-environment-vagrant +Developer Environment with Vagrant, Docker and Ansible + +## Remote Development with VSCode + +Connect to your VM via VSCode for MacOSx you hit `commannd + shift + P`, select "Remote-SSH: Connecto to Host": + +![image](https://user-images.githubusercontent.com/567298/174472060-09699a90-a017-45e2-ba83-1872d0c0ea19.png) + +Then we select our VM name, in my case "sektor": + +![image](https://user-images.githubusercontent.com/567298/174472130-f52c4666-6b2d-4041-80a5-55bf6ca0d7c6.png) + +Once it establishes a connection we will be on our VM: + +![image](https://user-images.githubusercontent.com/567298/174472198-74c7348d-b154-4311-80a3-572338767ae0.png) + +Select the "Explorer" on the left, navigate to the "project" folder: + +![image](https://user-images.githubusercontent.com/567298/174472366-0cedc35e-be12-4600-94b4-925e7de391c4.png) + +Then select "ok", then you should your project inside the vm: + +![image](https://user-images.githubusercontent.com/567298/174472455-c82c18b0-f0be-4701-aee7-c1292c252a0b.png) + +Open up a new terminal, from "Terminal -> New Terminal" at the top, and you should see: + +![image](https://user-images.githubusercontent.com/567298/174472501-140e6d7a-96c6-48cc-84ec-00a805c8362a.png) + diff --git a/Vagrantfile b/Vagrantfile index 935d99e..f5f9c5c 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -22,14 +22,15 @@ Vagrant.configure("2") do |config| SHELL config.vm.provision "docker" do |d| - d.run "nginx", image: "nginx:stable", - args: "-p 8080:80" + d.run "linux-dash", image: "imightbebob/linux-dash:x86", + args: "-p 8080:8080" end # Ansible provisioner config.vm.provision "ansible" do |ansible| ansible.compatibility_mode = "2.0" ansible.playbook = "ansible/playbook.yml" + # ansible.playbook = "ansible/playbook-no-roles.yml" ansible.inventory_path = "ansible/inventory" ansible.become = true end diff --git a/ansible/playbook-no-roles.yml b/ansible/playbook-no-roles.yml new file mode 100644 index 0000000..18e5223 --- /dev/null +++ b/ansible/playbook-no-roles.yml @@ -0,0 +1,15 @@ +--- +- hosts: sektor + name: basic playbook + vars: + dummy_key: dummy-value + tasks: + - name: Install apt packages + apt: + name: "{{ item }}" + state: latest + update_cache: yes + with_items: + - tar + - unzip + diff --git a/ansible/roles/main/defaults/main.yml b/ansible/roles/main/defaults/main.yml deleted file mode 100644 index 73b314f..0000000 --- a/ansible/roles/main/defaults/main.yml +++ /dev/null @@ -1 +0,0 @@ ---- \ No newline at end of file diff --git a/ansible/roles/main/tasks/main.yml b/ansible/roles/main/tasks/main.yml deleted file mode 100644 index 0e7df8f..0000000 --- a/ansible/roles/main/tasks/main.yml +++ /dev/null @@ -1,8 +0,0 @@ -- name: Install Promtail Dependencies - apt: - name: "{{ item }}" - state: latest - update_cache: yes - with_items: - - tar - - unzip diff --git a/ansible/roles/website/defaults/main.yml b/ansible/roles/website/defaults/main.yml index d7fdb31..a6fbe4c 100644 --- a/ansible/roles/website/defaults/main.yml +++ b/ansible/roles/website/defaults/main.yml @@ -11,11 +11,11 @@ nginx_server_name: "_" nginx_user: "www-data" nginx_web_root: "/var/www/app" root_group: "root" -webpage_title: "hello world" +webpage_title: "hello world!" webpage_text: "homepage" webpage_url: "https://ruan.dev" access_log_args: "main buffer=16k flush=2m" nginx_log_format: |- '$remote_addr - $remote_user [$time_local] "$request" ' '$status $body_bytes_sent "$http_referer" ' - '"$http_user_agent" "$http_x_forwarded_for"' \ No newline at end of file + '"$http_user_agent" "$http_x_forwarded_for"'