This commit is contained in:
parent
59973fb070
commit
106f388625
113
alpine/README.md
Normal file
113
alpine/README.md
Normal file
@ -0,0 +1,113 @@
|
||||
---
|
||||
name: Develop in Kubernetes
|
||||
description: Get started with Kubernetes development.
|
||||
tags: [cloud, kubernetes]
|
||||
---
|
||||
|
||||
# Getting started
|
||||
|
||||
This template creates a pod running the `codercom/enterprise-base:ubuntu` image.
|
||||
|
||||
## RBAC
|
||||
|
||||
The Coder provisioner requires permission to administer pods to use this template. The template
|
||||
creates workspaces in a single Kubernetes namespace, using the `workspaces_namespace` parameter set
|
||||
while creating the template.
|
||||
|
||||
Create a role as follows and bind it to the user or service account that runs the coder host.
|
||||
|
||||
```yaml
|
||||
apiVersion: rbac.authorization.k8s.io/v1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: coder
|
||||
rules:
|
||||
- apiGroups: [""]
|
||||
resources: ["pods"]
|
||||
verbs: ["*"]
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
This template can authenticate using in-cluster authentication, or using a kubeconfig local to the
|
||||
Coder host. For additional authentication options, consult the [Kubernetes provider
|
||||
documentation](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs).
|
||||
|
||||
### kubeconfig on Coder host
|
||||
|
||||
If the Coder host has a local `~/.kube/config`, you can use this to authenticate
|
||||
with Coder. Make sure this is done with same user that's running the `coder` service.
|
||||
|
||||
To use this authentication, set the parameter `use_kubeconfig` to true.
|
||||
|
||||
### In-cluster authentication
|
||||
|
||||
If the Coder host runs in a Pod on the same Kubernetes cluster as you are creating workspaces in,
|
||||
you can use in-cluster authentication.
|
||||
|
||||
To use this authentication, set the parameter `use_kubeconfig` to false.
|
||||
|
||||
The Terraform provisioner will automatically use the service account associated with the pod to
|
||||
authenticate to Kubernetes. Be sure to bind a [role with appropriate permission](#rbac) to the
|
||||
service account. For example, assuming the Coder host runs in the same namespace as you intend
|
||||
to create workspaces:
|
||||
|
||||
```yaml
|
||||
apiVersion: v1
|
||||
kind: ServiceAccount
|
||||
metadata:
|
||||
name: coder
|
||||
|
||||
---
|
||||
apiVersion: rbac.authorization.k8s.io/v1
|
||||
kind: RoleBinding
|
||||
metadata:
|
||||
name: coder
|
||||
subjects:
|
||||
- kind: ServiceAccount
|
||||
name: coder
|
||||
roleRef:
|
||||
kind: Role
|
||||
name: coder
|
||||
apiGroup: rbac.authorization.k8s.io
|
||||
```
|
||||
|
||||
Then start the Coder host with `serviceAccountName: coder` in the pod spec.
|
||||
|
||||
## Namespace
|
||||
|
||||
The target namespace in which the pod will be deployed is defined via the `coder_workspace`
|
||||
variable. The namespace must exist prior to creating workspaces.
|
||||
|
||||
## Persistence
|
||||
|
||||
The `/home/coder` directory in this example is persisted via the attached PersistentVolumeClaim.
|
||||
Any data saved outside of this directory will be wiped when the workspace stops.
|
||||
|
||||
Since most binary installations and environment configurations live outside of
|
||||
the `/home` directory, we suggest including these in the `startup_script` argument
|
||||
of the `coder_agent` resource block, which will run each time the workspace starts up.
|
||||
|
||||
For example, when installing the `aws` CLI, the install script will place the
|
||||
`aws` binary in `/usr/local/bin/aws`. To ensure the `aws` CLI is persisted across
|
||||
workspace starts/stops, include the following code in the `coder_agent` resource
|
||||
block of your workspace template:
|
||||
|
||||
```terraform
|
||||
resource "coder_agent" "main" {
|
||||
startup_script = <<EOT
|
||||
#!/bin/bash
|
||||
|
||||
# install AWS CLI
|
||||
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
|
||||
unzip awscliv2.zip
|
||||
sudo ./aws/install
|
||||
EOT
|
||||
}
|
||||
```
|
||||
|
||||
## code-server
|
||||
|
||||
`code-server` is installed via the `startup_script` argument in the `coder_agent`
|
||||
resource block. The `coder_app` resource is defined to access `code-server` through
|
||||
the dashboard UI over `localhost:13337`.
|
||||
119
alpine/main.tf
Normal file
119
alpine/main.tf
Normal file
@ -0,0 +1,119 @@
|
||||
terraform {
|
||||
required_providers {
|
||||
coder = {
|
||||
source = "coder/coder"
|
||||
version = "0.5.3"
|
||||
}
|
||||
kubernetes = {
|
||||
source = "hashicorp/kubernetes"
|
||||
version = "~> 2.12.1"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
provider "kubernetes" {
|
||||
# Authenticate via ~/.kube/config or a Coder-specific ServiceAccount, depending on admin preferences
|
||||
config_path = null
|
||||
}
|
||||
|
||||
provider "coder" {
|
||||
url = "http://coder.coder.svc.cluster.local"
|
||||
}
|
||||
|
||||
data "coder_workspace" "me" {}
|
||||
|
||||
resource "coder_agent" "main" {
|
||||
os = "linux"
|
||||
arch = "amd64"
|
||||
startup_script = <<EOT
|
||||
#!/bin/bash
|
||||
|
||||
# home folder can be empty, so copying default bash settings
|
||||
if [ ! -f ~/.profile ]; then
|
||||
cp /etc/skel/.profile $HOME
|
||||
fi
|
||||
if [ ! -f ~/.bashrc ]; then
|
||||
cp /etc/skel/.bashrc $HOME
|
||||
fi
|
||||
|
||||
# Clone the aports repository
|
||||
|
||||
# Generate abuild keys
|
||||
abuild-keygen -a -i
|
||||
|
||||
# install and start code-server
|
||||
curl -fsSL https://code-server.dev/install.sh | sh | tee code-server-install.log
|
||||
code-server --auth none --port 13337 | tee code-server-install.log &
|
||||
EOT
|
||||
}
|
||||
|
||||
# code-server
|
||||
resource "coder_app" "code-server" {
|
||||
agent_id = coder_agent.main.id
|
||||
name = "code-server"
|
||||
icon = "/icon/code.svg"
|
||||
url = "http://localhost:13337?folder=/home/coder"
|
||||
subdomain = false
|
||||
share = "owner"
|
||||
|
||||
healthcheck {
|
||||
url = "http://localhost:13337/healthz"
|
||||
interval = 3
|
||||
threshold = 10
|
||||
}
|
||||
}
|
||||
|
||||
resource "kubernetes_persistent_volume_claim" "home" {
|
||||
metadata {
|
||||
name = "coder-${lower(data.coder_workspace.me.owner)}-${lower(data.coder_workspace.me.name)}-home"
|
||||
namespace = "coder"
|
||||
}
|
||||
wait_until_bound = false
|
||||
spec {
|
||||
access_modes = ["ReadWriteOnce"]
|
||||
resources {
|
||||
requests = {
|
||||
storage = "10Gi"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
resource "kubernetes_pod" "main" {
|
||||
count = data.coder_workspace.me.start_count
|
||||
metadata {
|
||||
name = "coder-${lower(data.coder_workspace.me.owner)}-${lower(data.coder_workspace.me.name)}"
|
||||
namespace = "coder"
|
||||
}
|
||||
spec {
|
||||
security_context {
|
||||
run_as_user = "1000"
|
||||
fs_group = "1000"
|
||||
}
|
||||
container {
|
||||
name = "dev"
|
||||
image = "cr.smcm.xyz/coder-images/alpine:latest"
|
||||
command = ["bash", "-c", coder_agent.main.init_script]
|
||||
security_context {
|
||||
run_as_user = "1000"
|
||||
}
|
||||
env {
|
||||
name = "CODER_AGENT_TOKEN"
|
||||
value = coder_agent.main.token
|
||||
}
|
||||
volume_mount {
|
||||
mount_path = "/home/coder"
|
||||
name = "home"
|
||||
read_only = false
|
||||
}
|
||||
}
|
||||
|
||||
volume {
|
||||
name = "home"
|
||||
persistent_volume_claim {
|
||||
claim_name = kubernetes_persistent_volume_claim.home.metadata.0.name
|
||||
read_only = false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user