├── LICENSE ├── README.md ├── deployments ├── mongo-deployment.yaml └── pacman-deployment.yaml ├── pacman-install.sh ├── pacman-uninstall.sh ├── persistentvolumeclaim └── mongo-pvc.yaml ├── security ├── rbac.yaml └── secret.yaml └── services ├── mongo-service.yaml └── pacman-service.yaml /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Running Pac-Man on Kubernetes 2 | 3 | Pac-Man the classic arcade game - deployment files for VMware Tanzu Kubernetes and all other Kubernetes distributions. 4 | 5 | 6 | 7 | ## Pre-Reqs 8 | 9 | ServiceType: LoadBalancer must be available for external connectivity to the Pac-Man front-end, otherwise you'll need to make some changes to the files in the "services" folder. 10 | 11 | ## Deployment 12 | 13 | ### Using Helm to install 14 | ```` 15 | kubectl create namespace pacman 16 | 17 | helm repo add veducate https://saintdle.github.io/helm-charts/ 18 | helm install pacman veducate/pacman -n pacman 19 | 20 | # You can see the available values by running 21 | helm show values veducate/pacman 22 | ```` 23 | [Read this blog post](https://veducate.co.uk/how-to-create-helm-chart/) to learn how this Helm Chart was created. 24 | 25 | ### Using a Script for installation 26 | Clone repo and run ```chmod +X pacman-install.sh``` and then run file ```./pacman-install.sh``` 27 | 28 | or the following steps: 29 | 30 | kubectl create namespace pacman 31 | kubectl create -n pacman -f pacman-tanzu/ 32 | 33 | #### Uninstall using a Script 34 | Run file `./pacman-uninstall.sh`. This will delete all objects created by `./pacman-install.sh` 35 | 36 | Alternatively, run `./pacman-uninstall.sh keeppvc`. This will delete all objects except for the pacman namespace and the persistent volume claim. You can use this to demonstrate persistence of the MongoDB data by installing, playing a game and recording a high score, then unininstalling with the `keeppvc` argument. You can then run the installation again and the high score will persist. 37 | 38 | ## Architecture 39 | 40 | The application is made up of the following components: 41 | 42 | * Namespace 43 | * Deployment 44 | * MongoDB Pod 45 | * DB Authentication configured 46 | * Attached to a PVC 47 | * Pac-Man Pod 48 | * Nodejs web front end that connects back to the MongoDB Pod by looking for the Pod DNS address internally. 49 | * RBAC Configuration for Pod Security and Service Account 50 | * Secret which holds the data for the MongoDB Usernames and Passwords to be configured 51 | * Service 52 | * Type: LoadBalancer 53 | * Used to balance traffic to the Pac-Man Pods 54 | 55 | 56 | 57 | ## Source 58 | 59 | These are modified files from the below github repo for the node.js version, which contain the necessary changes to run in VMware Tanzu Kubernetes Grid (TKG) such as updated api values and pod security policies (psp) with associated service accounts and RBAC. 60 | 61 | > 62 | 63 | Security changes to the deployment such as setting up mongodb auth were thanks to [Dav1x](https://github.com/dav1x/) you can find his [Pac-Man deployment for OpenShift here](https://github.com/dav1x/pacman-ocp). 64 | -------------------------------------------------------------------------------- /deployments/mongo-deployment.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | labels: 5 | name: mongo 6 | name: mongo 7 | annotations: 8 | source: "https://github.com/saintdle/pacman-tanzu" 9 | spec: 10 | replicas: 1 11 | selector: 12 | matchLabels: 13 | name: mongo 14 | template: 15 | metadata: 16 | labels: 17 | name: mongo 18 | spec: 19 | initContainers: 20 | - args: 21 | - | 22 | mkdir -p /bitnami/mongodb 23 | chown -R "1001:1001" "/bitnami/mongodb" 24 | command: 25 | - /bin/bash 26 | - -ec 27 | image: docker.io/bitnami/bitnami-shell:10-debian-10-r158 28 | imagePullPolicy: Always 29 | name: volume-permissions 30 | resources: {} 31 | securityContext: 32 | runAsUser: 0 33 | terminationMessagePath: /dev/termination-log 34 | terminationMessagePolicy: File 35 | volumeMounts: 36 | - mountPath: /bitnami/mongodb 37 | name: mongo-db 38 | restartPolicy: Always 39 | schedulerName: default-scheduler 40 | securityContext: 41 | fsGroup: 1001 42 | serviceAccountName: default 43 | terminationGracePeriodSeconds: 30 44 | volumes: 45 | - name: mongo-db 46 | persistentVolumeClaim: 47 | claimName: mongo-storage 48 | containers: 49 | - image: bitnami/mongodb:4.4.8 50 | name: mongo 51 | env: 52 | - name: MONGODB_ROOT_PASSWORD 53 | valueFrom: 54 | secretKeyRef: 55 | key: database-admin-password 56 | name: mongodb-users-secret 57 | - name: MONGODB_DATABASE 58 | valueFrom: 59 | secretKeyRef: 60 | key: database-name 61 | name: mongodb-users-secret 62 | - name: MONGODB_PASSWORD 63 | valueFrom: 64 | secretKeyRef: 65 | key: database-password 66 | name: mongodb-users-secret 67 | - name: MONGODB_USERNAME 68 | valueFrom: 69 | secretKeyRef: 70 | key: database-user 71 | name: mongodb-users-secret 72 | readinessProbe: 73 | exec: 74 | command: 75 | - /bin/sh 76 | - -i 77 | - -c 78 | - mongo 127.0.0.1:27017/$MONGODB_DATABASE -u $MONGODB_USERNAME -p $MONGODB_PASSWORD 79 | --eval="quit()" 80 | ports: 81 | - name: mongo 82 | containerPort: 27017 83 | volumeMounts: 84 | - name: mongo-db 85 | mountPath: /bitnami/mongodb/ -------------------------------------------------------------------------------- /deployments/pacman-deployment.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | labels: 5 | name: pacman 6 | name: pacman 7 | annotations: 8 | source: "https://github.com/saintdle/pacman-tanzu" 9 | spec: 10 | replicas: 1 11 | selector: 12 | matchLabels: 13 | name: pacman 14 | template: 15 | metadata: 16 | labels: 17 | name: pacman 18 | spec: 19 | containers: 20 | - image: quay.io/ifont/pacman-nodejs-app:latest 21 | name: pacman 22 | ports: 23 | - containerPort: 8080 24 | name: http-server 25 | protocol: TCP 26 | livenessProbe: 27 | httpGet: 28 | path: / 29 | port: 8080 30 | readinessProbe: 31 | httpGet: 32 | path: / 33 | port: 8080 34 | env: 35 | - name: MONGO_SERVICE_HOST 36 | value: mongo 37 | - name: MONGO_AUTH_USER 38 | valueFrom: 39 | secretKeyRef: 40 | key: database-user 41 | name: mongodb-users-secret 42 | - name: MONGO_AUTH_PWD 43 | valueFrom: 44 | secretKeyRef: 45 | key: database-password 46 | name: mongodb-users-secret 47 | - name: MONGO_DATABASE 48 | value: pacman 49 | - name: MY_MONGO_PORT 50 | value: "27017" 51 | - name: MONGO_USE_SSL 52 | value: "false" 53 | - name: MONGO_VALIDATE_SSL 54 | value: "false" 55 | - name: MY_NODE_NAME 56 | valueFrom: 57 | fieldRef: 58 | apiVersion: v1 59 | fieldPath: spec.nodeName 60 | -------------------------------------------------------------------------------- /pacman-install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | kubectl create namespace pacman 4 | kubectl create -n pacman -f security/rbac.yaml 5 | kubectl create -n pacman -f security/secret.yaml 6 | kubectl create -n pacman -f persistentvolumeclaim/mongo-pvc.yaml 7 | kubectl create -n pacman -f deployments/mongo-deployment.yaml 8 | while [ "$(kubectl get pods -l=name='mongo' -n pacman -o jsonpath='{.items[*].status.containerStatuses[0].ready}')" != "true" ]; do 9 | sleep 5 10 | echo "Waiting for mongo pod to change to running status" 11 | done 12 | kubectl create -n pacman -f deployments/pacman-deployment.yaml 13 | kubectl create -n pacman -f services/mongo-service.yaml 14 | kubectl create -n pacman -f services/pacman-service.yaml -------------------------------------------------------------------------------- /pacman-uninstall.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | kubectl delete -n pacman -f security/rbac.yaml 4 | kubectl delete -n pacman -f security/secret.yaml 5 | kubectl delete -n pacman -f deployments/mongo-deployment.yaml 6 | kubectl delete -n pacman -f deployments/pacman-deployment.yaml 7 | kubectl delete -n pacman -f services/mongo-service.yaml 8 | kubectl delete -n pacman -f services/pacman-service.yaml 9 | 10 | if [[ $# -gt 0 && "$1" == "keeppvc" ]] 11 | then 12 | echo "Keeping namespace and persistent volume claim" 13 | else 14 | kubectl delete -n pacman -f persistentvolumeclaim/mongo-pvc.yaml 15 | kubectl delete namespace pacman 16 | fi -------------------------------------------------------------------------------- /persistentvolumeclaim/mongo-pvc.yaml: -------------------------------------------------------------------------------- 1 | kind: PersistentVolumeClaim 2 | apiVersion: v1 3 | metadata: 4 | name: mongo-storage 5 | namespace: pacman 6 | spec: 7 | accessModes: 8 | - ReadWriteOnce 9 | resources: 10 | requests: 11 | storage: 1Gi 12 | -------------------------------------------------------------------------------- /security/rbac.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: policy/v1beta1 2 | kind: PodSecurityPolicy 3 | metadata: 4 | name: pacman 5 | spec: 6 | privileged: true 7 | seLinux: 8 | rule: RunAsAny 9 | supplementalGroups: 10 | rule: RunAsAny 11 | runAsUser: 12 | rule: RunAsAny 13 | fsGroup: 14 | rule: RunAsAny 15 | volumes: 16 | - '*' 17 | --- 18 | kind: ClusterRole 19 | apiVersion: rbac.authorization.k8s.io/v1 20 | metadata: 21 | name: pacman-clusterrole 22 | rules: 23 | - apiGroups: 24 | - policy 25 | resources: 26 | - podsecuritypolicies 27 | verbs: 28 | - use 29 | resourceNames: 30 | - pacman 31 | - apiGroups: [""] 32 | resources: ["pods", "nodes"] 33 | verbs: ["get", "watch", "list"] 34 | --- 35 | apiVersion: rbac.authorization.k8s.io/v1 36 | kind: RoleBinding 37 | metadata: 38 | name: pacman-clusterrole 39 | namespace: pacman 40 | roleRef: 41 | apiGroup: rbac.authorization.k8s.io 42 | kind: ClusterRole 43 | name: pacman-clusterrole 44 | subjects: 45 | - apiGroup: rbac.authorization.k8s.io 46 | kind: Group 47 | name: system:serviceaccounts 48 | - kind: ServiceAccount 49 | name: default 50 | namespace: pacman 51 | --- 52 | apiVersion: rbac.authorization.k8s.io/v1 53 | kind: ClusterRoleBinding 54 | metadata: 55 | name: pacman-clusterrole 56 | namespace: pacman 57 | roleRef: 58 | apiGroup: rbac.authorization.k8s.io 59 | kind: ClusterRole 60 | name: pacman-clusterrole 61 | subjects: 62 | - apiGroup: rbac.authorization.k8s.io 63 | kind: Group 64 | name: system:serviceaccounts 65 | - kind: ServiceAccount 66 | name: default 67 | namespace: pacman 68 | --- 69 | -------------------------------------------------------------------------------- /security/secret.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: v1 3 | kind: Secret 4 | metadata: 5 | name: mongodb-users-secret 6 | namespace: pacman 7 | type: Opaque 8 | data: 9 | database-admin-name: Y2x5ZGU= 10 | database-admin-password: Y2x5ZGU= 11 | database-name: cGFjbWFu 12 | database-password: cGlua3k= 13 | database-user: Ymxpbmt5 -------------------------------------------------------------------------------- /services/mongo-service.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: Service 3 | metadata: 4 | labels: 5 | name: mongo 6 | name: mongo 7 | spec: 8 | type: ClusterIP 9 | ports: 10 | - port: 27017 11 | targetPort: 27017 12 | selector: 13 | name: mongo 14 | -------------------------------------------------------------------------------- /services/pacman-service.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: Service 3 | metadata: 4 | name: pacman 5 | labels: 6 | name: pacman 7 | spec: 8 | type: LoadBalancer 9 | ports: 10 | - port: 80 11 | targetPort: 8080 12 | protocol: TCP 13 | selector: 14 | name: pacman 15 | --------------------------------------------------------------------------------