Merge pull request #12 from jrb-s2c-github/V5_1_Public_Clone

Allowed to checkout from public repos without adding security key
jrb-s2c-github · Jul 14, 2024 · 0083557 · 0083557
2 parents d546b2f + 0c874fa
commit 0083557
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ project and can be downloaded from [here](https://drive.google.com/drive/folders
 - [Safe Clones With Ansible](https://dzone.com/articles/safe-clones-with-ansible)
 
 ## Using Wormhole as the Ansible controller
-Wormhole comes with both Ansible and ATomika cloned from GitHub. has been Atomika's 
+Wormhole comes with both Ansible and Atomika cloned from GitHub. Atomika's 
 root ($atomika-home) is located at /home/ansible/atomika/ meaning:
 * its playbooks is at /home/ansible/atomika/atomika;
 * those of jetpack at /home/ansible/atomika/jetpack and
@@ -72,6 +72,10 @@ root of atomika_wormhole with sudo password of 'atmin'.
 *Create two nodes*. On Windows this can be done by running the liftoff Powershell script from the [jrb-s2c-github/atomika_wormhole](https://github.com/jrb-s2c-github/atomika_wormhole) 
 project in a PowerShell admin console. This script can be found at startup_scripts/liftoff.ps1. 
 
+This will require 8GB of ram. Should ram be limited boot the control-plane/master with 2GB
+(change -MemoryStartupByte to 2GB in liftoff.ps1) or opt to use the single node inventory 
+in the inventory folder.
+
 Pick one of the two machines and use it as the Ansible controller. 
 
 #### Step 3
@@ -84,9 +88,9 @@ the ip addresses to that of the two nodes started in step 2. Ignore the builder
 until your cluster formed, and you are ready for fast deployments using jetpack.
 
 #### Step 5
-*Boot Atomika from /home/ansible/atomika/*:
-> ansible@wormhole:/home/ansible/atomika/$ ansible-playbook -i atomika/inventory/ha_atomika_inventory.yml atomika/k8s_boot.yml -K -e metal_lb_range=172.26.64.3-172.26.64.200
-
+*Boot Atomika from /home/ansible/atomika/* from an Ansible controller (anyone of the two machines):
+> ansible@wormhole:/home/ansible/atomika/$ ansible-playbook -i atomika/inventory/basic_inventory.yml atomika/k8s_boot.yml -K -e metal_lb_range=172.26.64.3-172.26.64.200
+                                                                
 The sudo password is 'atmin' and ip range should be on the gateway's subnet. It will be used to select an ip address for 
 the Ingress from. Run 'ip route' to find the gateway's ip address. 
 
@@ -103,6 +107,34 @@ Note the external IP and map it to www.demo.io in the hosts file (/etc/hosts or
 C:\Windows\System32\drivers\etc\hosts). Open www.demo.io in a browser and see Atomika 
 in action.
 
+## Test Jetpack and Ingress routing
+
+Get Atomika up and running.
+
+Run jetpack to checkout, compile, integrate and deploy the sample deployment 
+declarations from jetpack/vars.yml:
+>ansible-playbook jetpack/deploy.yml -i atomika/inventory/basic_inventory.yml -K
+Change inventory file should you not be using the basic inventory.
+
+Open http://www.demo.io/env1/hello and http://www.demo.io/env2/hello from a browser (or 
+curl) to see the [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) 
+routing to two different internal Kubernetes services.
+
+Here is how this routing is configured:
+```aidl
+ingress:
+  host: www.demo.io
+  rules:
+    - service: hello1
+      namespace: env1
+      ingress_path: /env1/hello
+      service_path: /
+    - service: hello2
+      namespace: env2
+      ingress_path: /env2/hello
+      service_path: /
+```
+
 ## Contributing
 Should you wish to contribute or improve code or documentation, feel free to fork and 
 create a pull request back for me to approve. Alternatively, drop me a message on 
@@ -389,9 +421,11 @@ The command to integrate and deploy is:
 
 As always, take care to specify the correct topology inventory to use after the -i switch.
 
-The play will request a GitHub personal access token. Read this [DZone.com](https://dzone.com/articles/safe-clones-with-ansible) 
-article for the background, but this will initiate a safe GIT clone. For now this access token has to addedd to all GitHub 
-repositories regardless whether it is private or not. This classic access token should be given the following scopes/permissions: 
+The play will request a GitHub personal access token. Hit enter to bypass all this for public repos or
+enter a classic access token for private repos.
+
+Read this [DZone.com](https://dzone.com/articles/safe-clones-with-ansible) 
+article for the background, but this will initiate a safe GIT clone. This classic access token should be given the following scopes/permissions: 
 *repo, admin:public_key, user, and admin:gpg_key*. 
 
 ## Testing Ingress and MetalLB LoadBalancer 
@@ -479,26 +513,26 @@ this keypair after first use should the security requirements warrant it.
 6) Keyscanning of controlled nodes by Ansible controller was implemented by the key_scan.yml playbook.
 7) Removed the amount of 'prompts/-e switches' to provide by making cluster formation more opinionated. For instance,
 providing a second user to be given a kubeconfig for kubectl commands is not mandatory anymore.
+8) Jetpack can clone from public repos without requiring security tokens.
 
 ## Outstanding
 1) Is it possible to upgrade the cluster K8s version from Ansible? 
-2) Graphical user interface to configure bootstrapping, Atomika topology and Jetpack CI/CD 
-3) Allow to clone public repos without having to authorize using a GitHub access token 
-4) Should it be possible to skip "mvn install" step? The JIB command is sufficient for single module projects. 
-5) Split atomika_base role out as it should only run once to prepare a target node for orchestration 
-6) Add group_vars to hold version info of metallb, ingress-nginx from k8s_ingress_controller.yml, k8s and containerd. Can 
-a BOM be generated from this?
-7) Add support for other Linux distro's using some sort of templating, starting with the undocumented ARCH linux/ Raspberry PI's 
-8) Jetpack should not delete namespaces everytime, it should only deploy what has changed
-9) Once Ubuntu nodes can be configured from scripts, work on a way to boot a Windows cluster from scratch with one click
+2) Graphical user interface to configure bootstrapping, Atomika topology and Jetpack CI/CD
+3) Should it be possible to skip "mvn install" step? The JIB command is sufficient for single module projects. 
+4) Split atomika_base role out as it should only run once to prepare a target node for orchestration 
+5) Add group_vars to hold version info of metallb, ingress-nginx from k8s_ingress_controller.yml, k8s and containerd. Can 
+a BOM be generated from this? 
+6) Add support for other Linux distro's using some sort of templating, starting with the undocumented ARCH linux/ Raspberry PI's 
+7) Jetpack should not delete namespaces everytime, it should only deploy what has changed 
+8) Once Ubuntu nodes can be configured from scripts, work on a way to boot a Windows cluster from scratch with one click
 from a GUI. 
-10) Testing harness 
-11) Run docker registry on one node so all images can be pulled from there by the other nodes in the cluster 
-12) DNS server to register name of Ingress to remove need to mess with hosts files. This
-is only a problem when not using Wormhole.
-13) Integration with ansible lint on some level 
-14) Defaulting metallb range to something on the gateway's local subnet 
-15) Checking whether things can be sped up by not gathering facts every time?
+9) Testing harness 
+10) Run docker registry on one node so all images can be pulled from there by the other nodes in the cluster 
+11) DNS server to register name of Ingress to remove need to mess with hosts files. This
+is only a problem when not using Wormhole. 
+12) Integration with ansible lint on some level 
+13) Defaulting metallb range to something on the gateway's local subnet 
+14) Checking whether things can be sped up by not gathering facts every time?
 
 # Common problems
 

diff --git a/TEST_PLAN.md b/TEST_PLAN.md
@@ -1,11 +1,15 @@
+# Atomika
 * ha
 * basic with ha_proxy    -> k8scp point at ha_proxy
 * basic without ha_proxy -> k8scp point at master 
 * single node    
-* with secondary user
-* without secondary user
+* with second user
+* without second user
 * vm's on HyperV default switch
 * vm's on HyperV switch with dedicated ethernet adaptor
-* jetpack
 * starting with wormhole as base, e.g. start at k8s_boot.yml
-* starting from ubuntu22 bare as base, e.g. start with k8s_init.yml
+* starting from ubuntu22 bare as base, e.g. start with k8s_init.yml
+
+Jetpack
+* integrate and deploy public repo
+* integrate and deploy private repo
diff --git a/jetpack/deploy.yml b/jetpack/deploy.yml
@@ -5,16 +5,35 @@
     - vars.yml
   vars_prompt:
     - name: github_token
-      prompt: "Enter your github personal access token?"
+      prompt: "Enter your github personal access token or hit enter for a public repo"
       private: true
   tasks:
+    - name: Remove test namespace
+      remote_user: ansible
+      kubernetes.core.k8s:
+        name: test
+        api_version: v1
+        kind: Namespace
+        state: absent
+
     - name: Install Maven
       ansible.builtin.apt:
         name: maven
         state: present
       become: true
 
-    - name: Checking out sources
+    # public repo
+    - name: Checking out sources from a public repo
+      ansible.builtin.git:
+        repo: "https://{{ git_server_fqdn }}/{{ item.github_account }}/{{ item.git_repo }}.git"
+        dest: "{{ item.name }}"
+        version: "{{ item.git_branch }}"
+      loop:
+        "{{ apps }}"
+      when: github_token == ""
+
+    # private repo
+    - name: Checking out sources from a private repo
       ansible.builtin.include_role:
         name: github-add-deploy-key
       vars:
@@ -28,17 +47,7 @@
         branch: "{{ item.git_branch }}"
       loop:
         "{{ apps }}"
-
-#  # should this step take forever, SSH is prompting for user authorization and the remote host's public key should be added to /etc/ssh/ssh_known_hosts
-## with key scan: ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_host
-#    - name: Git checkouts
-#      ansible.builtin.git:
-#        repo: "https://github.com/jrb-s2c-github/{{ item.git_repo }}.git"
-#        dest: "~/{{ item.name }}"
-#        version: "{{ item.git_branch }}"
-#      loop:
-#        "{{ apps }}"
-
+      when: github_token != ""
 
     - name: Maven install
       ansible.builtin.command: "mvn install"
@@ -100,7 +109,7 @@
           - pyyaml
           - kubernetes
 
-    - name: Remove all k8s namespaces
+    - name: Remove jetpack namespaces
       remote_user: ansible
       kubernetes.core.k8s:
         kubeconfig: /home/ansible/.kube/config
@@ -111,7 +120,17 @@
       loop:
         "{{ namespaces }}"
 
-    - pause: seconds=30
+    - name: Wait till jetpack namespaces have been deleted
+      kubernetes.core.k8s_info:
+        name: "{{ item.name }}"
+        api_version: v1
+        kind: Namespace
+        wait_sleep: 1
+        wait_timeout: 30
+        wait_condition:
+          type: Absent
+      loop:
+        "{{ namespaces }}"
 
     - name: Create k8s namespaces
       remote_user: ansible

diff --git a/jetpack/vars.yml b/jetpack/vars.yml
@@ -1,3 +1,5 @@
+git_server_fqdn: github.com
+
 apps:
   - name: hello1
     github_account: jrb-s2c-github
@@ -41,7 +43,8 @@ mvn_parents:
   - name: hello1/hello_svc
 
 pre_k8s_cmds:
-  - kubectl create ns temp
+  - kubectl get nodes
 
 post_k8s_cmds:
-  - kubectl delete ns temp
+  - kubectl get pods -A
+