mirror of
https://github.com/autistic-symposium/backend-and-orchestration-toolkit.git
synced 2025-06-08 06:53:00 -04:00
first commit
This commit is contained in:
commit
f4a26dbadc
8 changed files with 457 additions and 0 deletions
201
LICENSE
Executable file
201
LICENSE
Executable file
|
@ -0,0 +1,201 @@
|
|||
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.
|
142
README.md
Executable file
142
README.md
Executable file
|
@ -0,0 +1,142 @@
|
|||
# 🎨 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 follow:
|
||||
|
||||
1. Create a 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
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Useful General Commands
|
||||
|
||||
Checking out pods:
|
||||
|
||||
```
|
||||
$ kubectl get pods --namespace=<ns-name>
|
||||
```
|
||||
|
||||
Checking deployments:
|
||||
|
||||
```
|
||||
$ kubectl get deployments --namespace=<ns-name>
|
||||
```
|
||||
|
||||
Checking services:
|
||||
|
||||
```
|
||||
$ kubectl get services --namespace=<ns-name>
|
||||
```
|
||||
|
||||
Get more information about a pod:
|
||||
|
||||
```
|
||||
$ 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).
|
||||
|
||||
|
||||
----
|
||||
|
||||
|
||||
## 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/).
|
||||
|
18
node_example_kube_config.yaml
Executable file
18
node_example_kube_config.yaml
Executable file
|
@ -0,0 +1,18 @@
|
|||
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: quay.etsycorp.com:443/mwahl/node_app_test:1.0
|
||||
ports:
|
||||
- containerPort: 1337
|
||||
imagePullSecrets:
|
||||
- name: <encrypted password from quqy>
|
8
node_server_example/Dockerfile
Executable file
8
node_server_example/Dockerfile
Executable file
|
@ -0,0 +1,8 @@
|
|||
FROM node:4.4
|
||||
MAINTAINER "bt3"
|
||||
|
||||
EXPOSE 1337
|
||||
|
||||
COPY server.js .
|
||||
|
||||
CMD node server.js
|
15
node_server_example/Makefile
Executable file
15
node_server_example/Makefile
Executable file
|
@ -0,0 +1,15 @@
|
|||
.DELETE_ON_ERROR:
|
||||
|
||||
build:
|
||||
docker build -t node_app_test .
|
||||
|
||||
run:
|
||||
docker run -d -p 1337:1337 node_app_test
|
||||
|
||||
curl:
|
||||
curl localhost:1337
|
||||
|
||||
status:
|
||||
docker ps
|
||||
|
||||
.PHONY: build run curl status
|
44
node_server_example/README.md
Executable file
44
node_server_example/README.md
Executable file
|
@ -0,0 +1,44 @@
|
|||
# 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).
|
18
node_server_example/node_example_kube_config.yaml
Executable file
18
node_server_example/node_example_kube_config.yaml
Executable file
|
@ -0,0 +1,18 @@
|
|||
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: node_app_test:1.0
|
||||
ports:
|
||||
- containerPort: 1337
|
||||
imagePullSecrets:
|
||||
- name: <encrypted password your container registry>
|
11
node_server_example/server.js
Executable file
11
node_server_example/server.js
Executable file
|
@ -0,0 +1,11 @@
|
|||
var os = require("os");
|
||||
var hostname = os.hostname();
|
||||
var http = require('http');
|
||||
var handleRequest = function(request, response) {
|
||||
console.log('Received request for URL: ' + request.url);
|
||||
response.writeHead(200);
|
||||
response.end("Hello from container " + hostname + "!\n\n");
|
||||
};
|
||||
var www = http.createServer(handleRequest);
|
||||
www.listen(1337);
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue