Git-Mirrors/backend-and-orchestration-toolkit
1
0
Fork 0
mirror of https://github.com/autistic-symposium/backend-and-orchestration-toolkit.git synced 2025-06-27 16:07:25 -04:00
Code Issues Projects Releases Packages Wiki Activity

add some examples

Browse source
This commit is contained in:
Mia Steinkirch 2019-09-29 21:50:23 -07:00
parent 2a076a7d9a
commit ae742e3ee9
21 changed files with 336 additions and 374 deletions
Download patch file Download diff file Expand all files Collapse all files

201
LICENSE
View file

@ -1,201 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

119
README.md
View file

@ -1,102 +1,11 @@
# 🎨 A Quick Intro to K8s 🎨
In this guide, I show you how to spin a quick ```Node.js``` server in kubernetes and to grasp some of its main concepts.
### Install kubectl
First, you will need to install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) in your machine.
Make sure you have all the auths right, for instance, I do the following:
1. Create an auth token and move to `~/.kube`
2. Create a config file and move to `~/.kube`
### Spinning up a Hello World node server in docker
Download [this code](https://github.com/bt3gl/intro_to_k8s/tree/master/node_server_example) and build the image:
```
$ make build:
```
Now, just run the container:
```
$ make run
```
Which is:
```
docker build -t node_app_test .
```
Check whether the server is up:
```
$ make curl
```
Voilà!
You can also check the status of your setup with:
```
$ make status
```
#### Other useful Docker commands
Exec inside the container:
```
$ docker exec -i -t <container name from status> /bin/bash
```
Check images in disk:
```
$ docker images
```
### Pushing the Registry to Kubernetes
In a real production system, we’ll want to build images in one place, then run these images in the Kubernetes cluster.
The system that images for distribution is called a **container registry**.
Using a `yaml` Kubernetes files (for example, the one inside `node_server_example/`), you can now deploy the image with:
```
$ kubectl create -f node_example_kube_config.yaml
```
After that, you are able to create the service with:
```
$ kubectl expose deployment node-app-test
```
Also, check out the service status with:
```
$ kubectl get services
```
### Clean up
Removing the service and the deployment when you are done:
```
$ kubectl delete service node-app-test
$ kubectl delete deployment node-app-test
```
# Learning Kubernetes.
## Useful General Commands
## Kubectl
Kubectl is a command line interface for running commands against Kubernetes clusters. You can install it [here](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
Checking out pods:
@ -123,20 +32,8 @@ $ kubectl describe pod --namespace=<ns-name> <pod name>
```
## Some References:
* [Dockerfiles good practices](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#general-guidelines-and-recommendations).
## Examples in this repo
----
## License
When making a reference to my work, please use my [website](http://bt3gl.github.io/index.html).
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />
This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).
* Spin up a node server example.
* Use kustomize to organize and combine YAML templates of your services and deployments.

3
kustomize-example/.gitignore vendored Normal file
View file

@ -0,0 +1,3 @@
/base/mysql/kubeconfig_victoria_eks_ggtest.json
/base/wordpress/kubeconfig_victoria_eks_ggtest.json
/overlays/dev/kubeconfig_victoria_eks_ggtest.json

120
kustomize-example/README.md Normal file
View file

@ -0,0 +1,120 @@
# Introduction to Kustomize - Wordpress Example
[Kustomize](https://kustomize.io/) is a tool that lets you create an entire Kubernetes application out of individual pieces — without touching the YAML for the individual components.
Kustomize traverses a Kubernetes manifest to add, remove or update configuration options without forking. It is available both as a standalone binary and as a native feature of kubectl.
Kustomize enables you to do that by creating a file that ties everything together, or optionally includes “overrides” for individual parameters.
In this example, you will learn how to use Kustomize to setup a Wordpress Kubernetes clusters.
### Set Minukube
For this demo, you can use a local Kubernetes cluster that can be provided by [minikube](https://github.com/kubernetes/minikube). Install minikube following [this](instructions).
Start your cluster:
```
minikube start
```
### Install Kustomize
```
brew install kustomize
kustomize version
```
### Deploying Wordpress
To run WordPress, it's necessary to connect WordPress with a MySQL database and access the service name of MySQL database from WordPress container.
Set the base directory:
```
KUSTOM_HOME=$(pwd)
BASE=$KUSTOM_HOME/base
```
Deploy Wordpress:
```
WORDPRESS_HOME=$BASE/wordpress
cd $WORDPRESS_HOME
kubectl apply -f $WORDPRESS_HOME
```
Deploy MySQL:
```
MYSQL_HOME=$BASE/mysql
cd $MYSQL_HOME
kubectl apply -f $MYSQL_HOME
```
In each of these two directories, you should see three resources YAML files, and they are the elements of each individual deployment:
- `deployment.yaml`
- `kustomization.yaml`
- `service.yaml`
In the next step, we will use Kustomize to deploy everything by combining these files into a single file. But before we move on, let's clean up the individual deployments:
```
kubectl delete -f $WORDPRESS_HOME
kubectl delete -f $MYSQL_HOME
```
The way Kustomize connects these two directories is by adding the following in their
`kustomization.yaml` files:
```
commonLabels:
app: my-wordpress
```
Now we can use Kustomize to build the new YAML. The output from Kustomize is the concatenation of YAML documents for all the resources we specified, with the common labels added, which can be piped directly to `kubectl`:
```
kustomize build $BASE | kubectl apply -f -
```
Now, you can check that the services are up (you should see `mysql` and `wordpress`):
```
kubectl get services
```
### Applying Overlays
Overlays enable us to take the base YAML and selectively change pieces of it.
In this example, we’re going to create an overlay that includes a patch to change the Services to NodePort type services.
The overlay should not be in the same directory as the base files, and in this case, we are using `$BASE/overlays/dev`.
From `victoria` root directory, run:
```
OVERLAY_HOME=($pwd)/overlays
DEV_HOME=$OVERLAY_HOME/dev
cd $DEV_HOME
```
Now you can apply the overlay changes with:
```
kubectl apply -k $DEV_HOME
```
## Cleaning app
To clean up the resources created from this exercise:
```
kubectl delete -f $BASE
minikube stop
```

5
kustomize-example/base/kustomization.yaml Normal file
View file

@ -0,0 +1,5 @@
commonLabels:
app: my-wordpress
bases:
- ./wordpress
- ./mysql

35
kustomize-example/base/mysql/deployment.yaml Normal file
View file

@ -0,0 +1,35 @@
apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: mysql
labels:
app: mysql
spec:
selector:
matchLabels:
app: mysql
strategy:
type: Recreate
template:
metadata:
labels:
app: mysql
spec:
containers:
- image: mysql:5.6
name: mysql
env:
- name: MYSQL_ROOT_PASSWORD
valueFrom:
secretKeyRef:
name: mysql-pass
key: password
ports:
- containerPort: 3306
name: mysql
volumeMounts:
- name: mysql-persistent-storage
mountPath: /var/lib/mysql
volumes:
- name: mysql-persistent-storage
emptyDir: {}

4
kustomize-example/base/mysql/kustomization.yaml Normal file
View file

@ -0,0 +1,4 @@
resources:
- deployment.yaml
- service.yaml
- secret.yaml

8
kustomize-example/base/mysql/secret.yaml Normal file
View file

@ -0,0 +1,8 @@
apiVersion: v1
kind: Secret
metadata:
name: mysql-pass
type: Opaque
data:
# Default password is "admin".
password: YWRtaW4=

11
kustomize-example/base/mysql/service.yaml Normal file
View file

@ -0,0 +1,11 @@
apiVersion: v1
kind: Service
metadata:
name: mysql
labels:
app: mysql
spec:
ports:
- port: 3306
selector:
app: mysql

29
kustomize-example/base/wordpress/deployment.yaml Normal file
View file

@ -0,0 +1,29 @@
apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: wordpress
labels:
app: wordpress
spec:
selector:
matchLabels:
app: wordpress
strategy:
type: Recreate
template:
metadata:
labels:
app: wordpress
spec:
containers:
- image: wordpress:4.8-apache
name: wordpress
ports:
- containerPort: 80
name: wordpress
volumeMounts:
- name: wordpress-persistent-storage
mountPath: /var/www/html
volumes:
- name: wordpress-persistent-storage
emptyDir: {}

3
kustomize-example/base/wordpress/kustomization.yaml Normal file
View file

@ -0,0 +1,3 @@
resources:
- deployment.yaml
- service.yaml

12
kustomize-example/base/wordpress/service.yaml Normal file
View file

@ -0,0 +1,12 @@
apiVersion: v1
kind: Service
metadata:
name: wordpress
labels:
app: wordpress
spec:
ports:
- port: 80
selector:
app: wordpress
type: LoadBalancer

4
kustomize-example/overlays/dev/kustomization.yaml Normal file
View file

@ -0,0 +1,4 @@
bases:
- ../../base
patchesStrategicMerge:
- localserv.yaml

13
kustomize-example/overlays/dev/localserv.yaml Normal file
View file

@ -0,0 +1,13 @@
apiVersion: v1
kind: Service
metadata:
name: wordpress
spec:
type: NodePort
---
apiVersion: v1
kind: Service
metadata:
name: mysql
spec:
type: NodePort

0
node_server_example/Dockerfile → node-server-example/Dockerfile
View file

0
node_server_example/Makefile → node-server-example/Makefile
View file

81
node-server-example/README.md Executable file
View file

@ -0,0 +1,81 @@
# Deploying a Node.js K8s Cluster with Kubectl
Build the image:
```
make build:
```
Run the container:
```
make run
```
Check whether the server worked
```
make curl
```
Check container's status
```
$ make status
```
#### Other useful commands
Exec inside the container:
```
$ docker exec -i -t <container name from status> /bin/bash
```
Check images in disk:
```
$ docker images
```
### Pushing the Registry to Kubernetes
In a real production system, we’ll want to build images in one place, then run these images in the Kubernetes cluster.
The system that images for distribution is called a **container registry**.
Using a `yaml` Kubernetes files (for example, the one inside `node_server_example/`), you can now deploy the image with:
```
$ kubectl create -f node_example_kube_config.yaml
```
After that, you are able to create the service with:
```
$ kubectl expose deployment node-app-test
```
Also, check out the service status with:
```
$ kubectl get services
```
### Clean up
Removing the service and the deployment when you are done:
```
$ kubectl delete service node-app-test
$ kubectl delete deployment node-app-test
```
## Some References:
* [Dockerfiles good practices](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#general-guidelines-and-recommendations).

0
node_server_example/node_example_kube_config.yaml → node-server-example/node_example_kube_config.yaml
View file

0
node_server_example/server.js → node-server-example/server.js
View file

18
node_example_kube_config.yaml
View file

@ -1,18 +0,0 @@
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: node_app_test
spec:
replicas: 1
template:
metadata:
labels:
run: node_app_test
spec:
containers:
- name: node_app_test
image: <host>:443/<user>/node_app_test:1.0
ports:
- containerPort: 1337
imagePullSecrets:
- name: <encrypted password from quqy>

44
node_server_example/README.md
View file

@ -1,44 +0,0 @@
# Spinning up a Hello World node server in docker
Build the image:
```
$ make build:
```
Run the container:
```
$ make run
```
docker build -t node_app_test .
Check whether the server worked:
```
$ make curl
```
Check container's status:
```
$ make status
```
#### Other useful commands
Exec inside the container:
```
$ docker exec -i -t <container name from status> /bin/bash
```
Check images in disk:
```
$ docker images
```
## Some References:
* [Dockerfiles good practices](https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/#general-guidelines-and-recommendations).