Add example for deploying via Docker / k8s and Linkerd

examples/k8s/.dockerignore

@@ -0,0 +1 @@
+node_modules

examples/k8s/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

examples/k8s/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:10
+
+# Setting working directory. All the path will be relative to WORKDIR
+WORKDIR /usr/src/app
+
+# Installing dependencies
+COPY package*.json ./
+RUN npm install
+
+# Copying source files
+COPY . .
+
+# Building app
+RUN npm run build
+
+# Running the app
+CMD [ "npm", "start" ]

examples/k8s/README.md

@@ -0,0 +1,111 @@
+# Deploying a Dockerized React App to Kubernetes Cluster
+
+## Prerequisites
+* Tutorial was done on macOS.
+* Tutorial assumes you have Homebrew installed on you computer. If not, you can install here: https://brew.sh
+* Tutorial assumes you have Docker installed on your computer. If not, you can install it here: https://docs.docker.com/docker-for-mac/install/
+
+## Step 1: Dockerize app
+
+### Build Docker image
+```sh
+$ docker build -t runme/demo .
+```
+
+### Run image locally to make sure it works
+```sh { interactive=false }
+$ docker run -d -p 3000:3000 runme/demo:latest
+```
+
+### Open Application
+
+And see it running:
+
+```sh
+open http://localhost:3000
+```
+
+then stop the container:
+
+```sh { interactive=false }
+$ docker ps | grep runme/demo:latest
+```
+
+Stop the container via:
+
+```sh
+$ docker stop <container-id>
+```
+
+## Step 2: Deploy application to Kubernetes Cluster with Linkerd
+
+### Install Linkerd
+
+```sh
+brew install linkerd
+```
+
+Setup Linkerd in the cluster, via:
+
+```sh
+linkerd install --crds | kubectl apply -f -
+```
+
+and
+
+```sh
+linkerd install --set proxyInit.runAsRoot=true | kubectl apply -f -
+```
+
+### Build a config file for the deployment of the image onto the cluster
+```sh { interactive=false }
+kubectl create -f k8deployment.yaml --save-config
+```
+
+### View Kubernetes deployments to see if the app was deployed to your cluster and see status
+```sh { interactive=false }
+$ kubectl get deployments
+```
+
+### View Kubernetes pods to verify pods/replicas are running
+```sh { interactive=false }
+$ kubectl get pods
+```
+
+### Verify logs in pod to see if the server for React app started
+```sh { interactive=false }
+$ kubectl logs POD NAME
+```
+
+### Port forward service
+```sh { interactive=false }
+$ kubectl port-forward services/<service-name> 3000:3000 -n default
+```
+
+### View your web app on the service by visiting http://EXTERNAL-IP:PORT
+
+You can view what the final web app looks like here:
+
+```sh
+open http://localhost:3000/
+```
+
+### Inject Linkerd
+
+```sh
+kubectl get -n default deploy -o yaml \
+  | linkerd inject - \
+  | kubectl apply -f -
+```
+
+Install viz extension:
+
+```sh
+linkerd viz install | kubectl apply -f - # install the on-cluster metrics stack
+```
+
+Start Dashboard:
+
+```sh { background=true }
+linkerd viz dashboard --verbose
+```

examples/k8s/k8deployment.yaml

@@ -0,0 +1,35 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: runme-demo
+  labels:
+    app: runme-demo
+spec:
+  replicas: 3
+  selector:
+    matchLabels:
+      app: runme-demo
+  template:
+    metadata:
+      labels:
+        app: runme-demo
+    spec:
+      containers:
+      - name: runme-demo
+        image: runme/demo:latest
+        imagePullPolicy: Never
+        ports:
+        - containerPort: 3000
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: runme-demo
+  labels:
+    app: runme-demo
+spec:
+  type: LoadBalancer
+  ports:
+  - port: 3000
+  selector:
+    app: runme-demo

examples/k8s/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "kubernetes-runme-react-app",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "react": "^16.12.0",
+    "react-dom": "^16.12.0",
+    "react-scripts": "3.2.0"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}

examples/k8s/public/index.html

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-react-app"
+    />
+    <link rel="apple-touch-icon" href="logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

examples/k8s/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

examples/k8s/public/robots.txt

@@ -0,0 +1,2 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *

examples/k8s/src/App.css

@@ -0,0 +1,22 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  height: 40vmin;
+}
+
+.App-header {
+  background-color: #282c34;
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.App-link {
+  color: #09d3ac;
+}

examples/k8s/src/App.js

@@ -0,0 +1,18 @@
+import React from 'react';
+import logo from './logo.svg';
+import './App.css';
+
+function App() {
+  return (
+    <div className="App">
+      <header className="App-header">
+        <img src={require('./kublogo.png')}/>
+        <p>
+          Containerized React app deployed to Kubernetes cluster via <a href="https://runme.dev" style={{color: '#F62459'}}><b style={{color: 'white'}}>Runme</b></a>
+        </p>
+      </header>
+    </div>
+  );
+}
+
+export default App;

examples/k8s/src/App.test.js

@@ -0,0 +1,9 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import App from './App';
+
+it('renders without crashing', () => {
+  const div = document.createElement('div');
+  ReactDOM.render(<App />, div);
+  ReactDOM.unmountComponentAtNode(div);
+});

examples/k8s/src/index.css

@@ -0,0 +1,13 @@
+body {
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen",
+    "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue",
+    sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+code {
+  font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New",
+    monospace;
+}

examples/k8s/src/index.js

@@ -0,0 +1,12 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import './index.css';
+import App from './App';
+import * as serviceWorker from './serviceWorker';
+
+ReactDOM.render(<App />, document.getElementById('root'));
+
+// If you want your app to work offline and load faster, you can change
+// unregister() to register() below. Note this comes with some pitfalls.
+// Learn more about service workers: https://bit.ly/CRA-PWA
+serviceWorker.unregister();