squash all commits

ggilmore · ggilmore · commit e35b3e3d0ea7 · 2020-04-09T10:49:56.000-07:00
diff --git a/.buildkite/hooks/pre-command b/.buildkite/hooks/pre-command
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -eu
+pushd "$(dirname "${BASH_SOURCE[0]}")"/../..
+
+TOOL_VERSION_FILES=()
+mapfile -d $'\0' TOOL_VERSION_FILES < <(fd .tool-versions --hidden --absolute-path --print0)
+
+for file in "${TOOL_VERSION_FILES[@]}"; do
+	echo "Installing asdf dependencies as defined in ${file}:"
+	parent=$(dirname "${file}")
+	pushd "${parent}"
+
+	asdf install
+
+	popd
+done
+
+popd
diff --git a/.buildkite/pipeline.yaml b/.buildkite/pipeline.yaml
@@ -0,0 +1,3 @@
+steps:
+  - label: ':lipstick:'
+    command: .buildkite/prettier-check.sh
diff --git a/.buildkite/prettier-check.sh b/.buildkite/prettier-check.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+cd "$(dirname "${BASH_SOURCE[0]}")"/..
+set -euxo pipefail
+
+yarn
+
+yarn run prettier-check
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,15 @@
+/bin/
+/node_modules/
+yarn-error.log
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+.history
+
+.envrc
+
+Pulumi.dev.yaml
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+12.16.1
diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1,4 @@
+yarn 1.22.4
+kubectl 1.17.3
+fd 7.4.0
+pulumi 1.14.0
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "editor.formatOnSave": true
+}
diff --git a/Pulumi.yaml b/Pulumi.yaml
@@ -0,0 +1,3 @@
+name: sourcegraph-deploy-kubernetes-helper
+runtime: nodejs
+description: A small helper program to aid in creating a test cluster for https://github.com/sourcegraph/deploy-sourcegraph.
diff --git a/README.md b/README.md
@@ -0,0 +1,75 @@
+# deploy-k8s-helper 
+
+A small helper program to aid in creating a test cluster for https://github.com/sourcegraph/deploy-sourcegraph. 
+
+## Prerequisites 
+
+- [Pulumi](https://pulumi.io/quickstart/install.html)
+    - Run `pulumi login` after installation
+- [Yarn](https://yarnpkg.com/en/)
+- GCP access to the ["Sourcegraph Auxiliary" (sourcegraph-server) GCP project](https://console.cloud.google.com/kubernetes/list?project=sourcegraph-server)
+    - Run `gcloud auth application-default login` to fetch the necessary credentials for Pulumi to use 
+- https://github.com/sourcegraph/deploy-sourcegraph checked out on your local machine
+    - deploy-k8s-helper reads the contents of that directory. Make sure your that your checkout is up-to-date!
+
+### Configuration
+
+See [config.ts](config.ts) for more information, but you **must** set the following configuration values via `pulumi config set <NAME> <VALUE>`
+
+- `gcloudEmail` -  The email that you use to sign in to our GCP project.
+    - example: geoffrey@sourcegraph.com
+- `deploySourcegraphRoot` - The path to the root of your https://github.com/sourcegraph/deploy-sourcegraph checkout.
+    - example: /Users/ggilmore/dev/go/src/github.com/sourcegraph/deploy-sourcegraph
+
+## Usage 
+
+Run `yarn` so that you install all the necessary dependencies. 
+
+- `yarn up`: creates a new GKE cluster and fetches the necessary credentials
+- `yarn destroy`: deletes a GKE cluster that was previously created with `yarn up`
+- `yarn auth`: fetch the credentials so that kubectl can speak to the cluster
+- `yarn deauth`: remove the cluster's kubectl credentials
+- `yarn web`: opens the GCP page for your cluster in your webrowser
+
+## Troubleshooting
+
+### The zone '...' doesn't have enough resources to fulfill the request
+
+Example:
+
+```
+Do you want to perform this update? yes
+Updating (dev):
+
+     Type                      Name                       Status                  Info
+ +   pulumi:pulumi:Stack       sg-deploy-k8s-helper-dev   **creating failed**     1 error
+ +   └─ gcp:container:Cluster  geoffrey-sourcegraph-test  **creating failed**     1 error
+
+Diagnostics:
+  pulumi:pulumi:Stack (sg-deploy-k8s-helper-dev):
+    error: update failed
+
+  gcp:container:Cluster (geoffrey-sourcegraph-test):
+    error: Plan apply failed: Error waiting for creating GKE cluster: Deploy error: Not all instances running in IGM after 46.650887217s. Expect 4. Current errors: [ZONE_RESOURCE_POOL_EXHAUSTED_WITH_DETAILS]: Instance 'gke-geoffrey-sourcegraph-default-pool-7f493867-0bmt' creation failed: The zone 'projects/sourcegraph-server/zones/us-central1-a' does not have enough resources available to fulfill the request.  '(resource type:compute)'. - ; .
+```
+
+Solution: Pick another zone to use from https://cloud.google.com/compute/docs/regions-zones/#available. Set it in your stack configuration by running `pulumi config set gcp:zone [NEW_ZONE]`
+
+### (ingress-nginx) Cannot read property 'status' of undefined
+
+This happens if you're trying to deploy a pre-`3.x` release of https://github.com/sourcegraph/deploy-sourcegraph/ (which didn't have `nginx-ingress`). 
+
+Example:
+
+```
+Diagnostics:
+  pulumi:pulumi:Stack (sg-deploy-k8s-helper-dev):
+    error: Running program '/Users/ggilmore/dev/go/src/github.com/sourcegraph/ds-k8s-helper' failed with an unhandled exception:
+    TypeError: Cannot read property 'status' of undefined
+        at exports.ingressIPs.ingressNginx.getResource.apply.svc (/Users/ggilmore/dev/go/src/github.com/sourcegraph/ds-k8s-helper/index.ts:49:23)
+        at OutputImpl.<anonymous> (/Users/ggilmore/dev/go/src/github.com/sourcegraph/ds-k8s-helper/node_modules/@pulumi/kubernetes/node_modules/@pulumi/pulumi/output.js:102:47)
+        at Generator.next (<anonymous>)
+        at fulfilled (/Users/ggilmore/dev/go/src/github.com/sourcegraph/ds-k8s-helper/node_modules/@pulumi/kubernetes/node_modules/@pulumi/pulumi/output.js:17:58)
+```
+
+Solution: Comment out the `const ingressNginx` and `export const ingressIPs` variables in https://github.com/sourcegraph/deploy-k8s-helper/blob/master/index.ts : https://github.com/sourcegraph/deploy-k8s-helper/blob/87bce4bb4f4448336a5b7feabca23bf1747b9fda/index.ts#L61-L72
diff --git a/cluster.ts b/cluster.ts
@@ -0,0 +1,89 @@
+import * as gcp from '@pulumi/gcp'
+import * as k8s from '@pulumi/kubernetes'
+import * as pulumi from '@pulumi/pulumi'
+
+import * as os from 'os'
+import { URL } from 'url'
+
+import { clusterConfig, gcloudConfig } from './config'
+
+const name = clusterConfig.name || `${os.userInfo().username}-sourcegraph-test`
+
+const cluster = new gcp.container.Cluster(name, {
+    // Don't auto-generate a name iff the user explicitly defined one.
+    name: clusterConfig.name,
+
+    description: 'Scratch cluster used for testing sourcegraph/deploy-sourcegraph',
+
+    location: gcloudConfig.location,
+    project: gcloudConfig.project,
+
+    initialNodeCount: clusterConfig.nodeCount,
+    removeDefaultNodePool: true,
+
+    nodeConfig: {
+        diskType: 'pd-ssd',
+        localSsdCount: 1,
+        machineType: clusterConfig.machineType,
+
+        oauthScopes: [
+            'https://www.googleapis.com/auth/compute',
+            'https://www.googleapis.com/auth/devstorage.read_only',
+            'https://www.googleapis.com/auth/logging.write',
+            'https://www.googleapis.com/auth/monitoring',
+        ],
+    },
+})
+
+export const clusterContext = pulumi
+    .all([cluster.name, cluster.location, cluster.project])
+    .apply(([name, location, project]) => `gke_${project}_${location}_${name}`)
+
+export const kubeconfig = pulumi
+    .all([clusterContext, cluster.endpoint, cluster.masterAuth])
+    .apply(([context, endpoint, masterAuth]) => {
+        return `apiVersion: v1
+clusters:
+- cluster:
+    certificate-authority-data: ${masterAuth.clusterCaCertificate}
+    server: https://${endpoint}
+  name: ${context}
+contexts:
+- context:
+    cluster: ${context}
+    user: ${context}
+  name: ${context}
+current-context: ${context}
+kind: Config
+preferences: {}
+users:
+- name: ${context}
+  user:
+    auth-provider:
+      config:
+        cmd-args: config config-helper --format=json
+        cmd-path: gcloud
+        expiry-key: '{.credential.token_expiry}'
+        token-key: '{.credential.access_token}'
+      name: gcp
+`
+    })
+
+export const gcloudAuthCommand = pulumi
+    .all([cluster.name, cluster.location, cluster.project])
+    .apply(
+        ([name, location, project]) =>
+            `gcloud container clusters get-credentials ${name} --location ${location} --project ${project}`
+    )
+
+export const gcpURL = pulumi
+    .all([cluster.name, cluster.location, cluster.project])
+    .apply(([name, location, project]) => {
+        const url = new URL(`${location}/${name}`, 'https://console.cloud.google.com/kubernetes/clusters/details/')
+        url.searchParams.set('project', project)
+        return url.toString()
+    })
+
+export const k8sProvider = new k8s.Provider(name, {
+    kubeconfig,
+})
diff --git a/config.ts b/config.ts
@@ -0,0 +1,50 @@
+import * as gcp from '@pulumi/gcp'
+import * as pulumi from '@pulumi/pulumi'
+
+const config = new pulumi.Config()
+
+export const clusterConfig = {
+    /**
+     * The name for the GKE cluster. A name will be auto-generated
+     * for the cluster if the configuation value is undefefined.
+     */
+    name: config.get('clusterName'),
+
+    /**
+     * The number of nodes to create in this cluster.
+     * Defaults to 4.
+     */
+    nodeCount: config.getNumber('nodeCount') || 4,
+
+    /**
+     * The name of a Google Compute Engine machine type.
+     * Defaults to n1-standard-8.
+     */
+    machineType: config.get('machineType') || 'n1-standard-8',
+}
+
+export const gcloudConfig = {
+    /**
+     * The name of the GCP Project to create the cluster inside of.
+     * Defaults to 'sourcegraph-server' (Sourcegraph Auxiliary).
+     */
+    project: gcp.config.project || 'sourcegraph-server',
+
+    /**
+     * The name of the GCP zone to create the cluster inside of.
+     * Defaults to 'us-central1-a'.
+     */
+    location: gcp.config.zone || 'us-central1-a',
+
+    /**
+     * The email that you use to sign in to our GCP project.
+     * Example: geoffrey@sourcegraph.com
+     */
+    username: config.require('gcloudEmail'),
+}
+
+/**
+ * The path to the root of your sourcegraph/deploy-sourcegraph checkout.
+ * Example: /Users/ggilmore/dev/go/src/github.com/sourcegraph/deploy-sourcegraph
+ */
+export const deploySourcegraphRoot = config.require('deploySourcegraphRoot')
diff --git a/index.ts b/index.ts
@@ -0,0 +1,73 @@
+import * as os from 'os'
+import * as path from 'path'
+
+import * as k8s from '@pulumi/kubernetes'
+
+import { k8sProvider } from './cluster'
+import { deploySourcegraphRoot, gcloudConfig } from './config'
+
+const clusterAdmin = new k8s.rbac.v1.ClusterRoleBinding(
+    'cluster-admin-role-binding',
+    {
+        metadata: { name: `${os.userInfo().username}-cluster-admin-role-binding` },
+
+        roleRef: {
+            apiGroup: 'rbac.authorization.k8s.io',
+            kind: 'ClusterRole',
+            name: 'cluster-admin',
+        },
+
+        subjects: [
+            {
+                apiGroup: 'rbac.authorization.k8s.io',
+                kind: 'User',
+                name: gcloudConfig.username,
+            },
+        ],
+    },
+    { provider: k8sProvider }
+)
+
+const storageClass = new k8s.storage.v1.StorageClass(
+    'sourcegraph-storage-class',
+    {
+        metadata: {
+            name: 'sourcegraph',
+
+            labels: {
+                deploy: 'sourcegraph',
+            },
+        },
+        provisioner: 'kubernetes.io/gce-pd',
+
+        parameters: {
+            type: 'pd-ssd',
+        },
+    },
+    { provider: k8sProvider }
+)
+
+const baseDeployment = new k8s.yaml.ConfigGroup(
+    'base',
+    {
+        files: `${path.posix.join(deploySourcegraphRoot, 'base')}/**/*.yaml`,
+    },
+    {
+        providers: { kubernetes: k8sProvider },
+        dependsOn: [clusterAdmin, storageClass],
+    }
+)
+
+const ingressNginx = new k8s.yaml.ConfigGroup(
+    'ingress-nginx',
+    {
+        files: `${path.posix.join(deploySourcegraphRoot, 'configure', 'ingress-nginx')}/**/*.yaml`,
+    },
+    { providers: { kubernetes: k8sProvider }, dependsOn: clusterAdmin }
+)
+
+export const ingressIPs = ingressNginx
+    .getResource('v1/Service', 'ingress-nginx', 'ingress-nginx')
+    .apply(svc => svc.status.apply(status => status.loadBalancer.ingress.map(i => i.ip)))
+
+export * from './cluster'
diff --git a/package.json b/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "sg-deploy-k8s-helper",
+  "scripts": {
+    "up": "pulumi up",
+    "postup": "yarn auth",
+    "destroy": "pulumi destroy",
+    "predestroy": "yarn deauth",
+    "auth": "$(pulumi stack output gcloudAuthCommand)",
+    "deauth": "kubectl config delete-context $(pulumi stack output clusterContext)",
+    "web": "opn $(pulumi stack output gcpURL)",
+    "prettier": "prettier '**/{*.{js?(on),ts?(x),graphql,md,scss},.*.js?(on)}' --write --list-different --config prettier.config.js",
+    "prettier-check": "yarn -s run prettier --write=false"
+  },
+  "devDependencies": {
+    "@sourcegraph/prettierrc": "3.0.3",
+    "@types/node": "latest",
+    "opn-cli": "4.1.0",
+    "prettier": "2.0.4",
+    "tslint": "5.20.1",
+    "tslint-config-prettier": "1.18.0"
+  },
+  "dependencies": {
+    "@pulumi/gcp": "2.12.0",
+    "@pulumi/kubernetes": "1.6.0",
+    "@pulumi/pulumi": "1.14.0"
+  }
+}
diff --git a/prettier.config.js b/prettier.config.js
@@ -0,0 +1 @@
+module.exports = require("@sourcegraph/prettierrc");
diff --git a/renovate.json b/renovate.json
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tslint.json b/tslint.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+steps:`
	`2`	`+ - label: ':lipstick:'`
	`3`	`+ command: .buildkite/prettier-check.sh`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "editor.formatOnSave": true`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+name: sourcegraph-deploy-kubernetes-helper`
	`2`	`+runtime: nodejs`
	`3`	`+description: A small helper program to aid in creating a test cluster for https://github.com/sourcegraph/deploy-sourcegraph.`