如何在Kubernetes上搭建code-server 云IDE平台

随着开发人员工具向云迁移，云IDE平台的创建和应用越来越多。云IDE允许开发团队在统一的开发环境中实时合作，从而最大限度地减少不兼容性，提高生产率。通过Web可访问云的浏览器IDE，云可用于各种现代设备IDE。云IDE另一个优点是可以利用集群的能力，这可以大大超过计算机开发的处理能力。

code-server 运行在远程服务器上Microsoft Visual Studio Code，可直接访问您的浏览器。Visual Studio Code是集成的现代码编辑器Git支持、代码调试器、智能自动完成和可定制和可扩展的功能。这意味着你可以使用各种设备来运行不同的操作系统，手头总是有一个一致的开发环境。

你将在本教程中Kubernetes集群上设置code-server 云IDE平台，并在您的域中公开使用Let’s Encrypted证书进行保护。最后，你将拥有在你的Kubernetes集群上运行的Microsoft Visual Studio代码，可以通过HTTPS并受密码保护。

需要你对 Kubernetes 中的 Node、Pod、ReplicaSet、Deployment、Service、Ingress、ConfigMap 对一些核心基本概念有一定的了解。假如你没有接触过 k8s，也可以完全按照教程完成云 IDE部署，然后通过学习k8s官方文档 了解 Kubernetes 的各个组件

整个教程的实践操作大概需要时间 5 分钟 至 10 分钟。 本文章的YAML配置文件下载地址 k8s-examples/code-server

云 IDE 演示地址安装部署完成 ： https://code-server.hjue.top

本教程采用CSDN 提供开发云k8s学习环境，一键创造k8s环境。CSDN 开发云k8s 学习环境按小时付费，每小时只有 0.1元。学习后可释放主机资源，停止收费。

点击这里一键拥有 k8s 环境。 你也可以用其他方法创造自己k8s集群。 点击【立即购买】，几分钟后就可以拥有自己了k8s集群。 使用 ssh 终端工具登录云主机，下一步在终端中进行

在这一节中，你把code-server 安装到你的 Kubernetes并在集群中使用 Ingress控制器在您的域中公开。您还将设置访问密码。

您将在本地机器上存储部署配置code-server.yaml使用以下命令创建文件：

nano code-server.yaml  

将以下内容添加到文件中code-server.yaml中：

apiVersion: v1 kind: Namespace metadata:   name: code-server --- apiVersion: networking.k8s.io/v1 kind: Ingress metadata:   name: code-server   namespace: code-server   annotations:     kubernetes.io/ingress.class: traefik   spec:   rules:   - host: $CODE_SERVER_DOMAIN     http:       paths:       - pathType: Prefix         path: "/"         backend:           service:             name: code-server             port:               number: 80 --- apiVersion: v1 kind: Service metadata:  name:-server
 namespace: code-server
spec:
 ports:
 - port: 80
   targetPort: 8080
 selector:
   app: code-server
---
apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: code-server
  name: code-server
  namespace: code-server
spec:
  selector:
    matchLabels:
      app: code-server
  replicas: 1
  template:
    metadata:
      labels:
        app: code-server
    spec:
      containers:
      - image: codercom/code-server:latest
        imagePullPolicy: Always
        name: code-server
        env:
        - name: PASSWORD
          value: $CODE_SERVER_PASSWORD

保存并关闭该文件。

此配置定义了命名空间、部署、服务和入口。命名空间称为code-server，它将code-server 安装与集群的其余部分分开。部署包括codercom/code-serverDocker镜像的一个副本，以及一个名为PASSWORD的环境变量，该变量指定访问的密码。

code-server服务在内部公开端口80的实例(作为部署的一部分创建)。文件中定义的Ingress指定Ingress控制器为traefik，并且服务将服务于域名$CODE_SERVER_DOMAIN。

若你没有自己的域名，可以删除yaml文件中的 Ingress 的定义，用 IP 加端口访问云 IDE。

下面你通过命令定义$CODE_SERVER_DOMAIN和$CODE_SERVER_PASSWORD，请替换下面命令中的密码和域名

export CODE_SERVER_PASSWORD=your_password
export $CODE_SERVER_DOMAIN=your_domain

运行上面命令后，使用命令检查文件code-server.yaml中以上变量是否被替换

envsubst < code-server.yaml

envsubst 命令用来替换 code-server.yaml 文件中的变量

确认变量已替换后，通过运行以下命令在Kubernetes中创建资源：

envsubst < code-server.yaml| kubectl apply -f -

你将看到以下输出：

namespace/code-server unchanged
ingress.networking.k8s.io/code-server created
service/code-server unchanged
deployment.apps/code-server configured

你可以通过运行以下命令来查看code-server Pod是否可用：

kubectl get pods -w -n code-server

The output will look similar to this:

输出将如下所示：

NAME                           READY   STATUS              RESTARTS   AGE
code-server-5f4bc7bb5d-5l2s2   0/1     ContainerCreating   0          18s

大概 几分钟时间，状态变为Running时，code-server 已安装到你的集群中。

NAME                           READY   STATUS    RESTARTS   AGE
code-server-5f4bc7bb5d-5l2s2   1/1     Running   0          6m23s

现在，你可以在浏览器中访问你的域名，你将看到code-server 的登录提示。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-HQZgJN3M-1657794736294)(…/…/…/…/…/Library/Application Support/typora-user-images/image-20220714174854418.png)]

输入你在上一步中设置的密码值，然后点击【SUBMIT】。现在，你将进入code-server，并看到以下图形用户界面。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yf79i9gH-1657794736302)(…/…/…/…/…/Library/Application Support/typora-user-images/image-20220714175035063.png)]

你已经在你的Kubernetes集群中安装了code-server ，并可以在公网访问。下面，你将使用Cert-Manager提供加密证书以便https访问。

在本节中，你将通过向你的Ingress应用Let‘s Encrypt证书来保护你的code-server 安装，Cert-Manager将自动创建该证书。完成此步骤后，可以通过HTTPS访问你的code-server 。

安装证书管理器Cert-Manager ，执行以下命令安装Cert-Manager

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.2/cert-manager.yaml

命令执行输出如下

namespace/cert-manager created
customresourcedefinition.apiextensions.k8s.io/certificaterequests.cert-manager.io created
customresourcedefinition.apiextensions.k8s.io/certificates.cert-manager.io created
customresourcedefinition.apiextensions.k8s.io/challenges.acme.cert-manager.io created
...

我们可以通过使用如下命令来等待安装何时完成

kubectl --namespace cert-manager get pods -w

命令输出如下

NAME                                       READY   STATUS              RESTARTS   AGE
cert-manager-cainjector-5987875fc7-dclv7   0/1     ContainerCreating   0          8s
cert-manager-6dd9658548-td7zx              0/1     ContainerCreating   0          8s
cert-manager-webhook-7b4c5f579b-bwr69      0/1     ContainerCreating   0          8s

直到所有 pod 都处于Running 状态，按Ctrl+C 退出

下面添加配置为使用 Let’s Encrypt 的颁发者可以让你为集群的服务动态获取新证书。

新建文件letsencrypt-issuer-prod.yaml ：

nano letsencrypt-issuer-prod.yaml

内容如下

apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: letsencrypt-prod
spec:
  acme:
    server: https://acme-v02.api.letsencrypt.org/directory
    email: $EMAIL
    privateKeySecretRef:
      name: letsencrypt-prod
    solvers:
    - http01:
        ingress:
          class: traefik

替换下面命令中的xxx@xxx.com，创建ClusterIssuer

EMAIL=xxx@xxx.com envsubst < letsencrypt-issuer-prod.yaml| kubectl apply -f - 

我们可以使用如下命令查看ClusterIssuer的状态

kubectl  get clusterissuer

输出如下，你看到ClusterIssuer的状态正常，下面我们使用ClusterIssuer来颁发证书

NAME                  READY   AGE
letsencrypt-prod   True    68s

打开code-server.yaml编辑：

nano code-server.yaml

按照以下内容修改你的文件：

code-server.yaml

apiVersion: v1
kind: Namespace
metadata:
  name: code-server
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: code-server
  namespace: code-server
  annotations:
    kubernetes.io/ingress.class: traefik    
    cert-manager.io/cluster-issuer: letsencrypt-prod  

spec:
  tls:
  - hosts:
    - $CODE_SERVER_DOMAIN
    secretName: code-server-tls
  rules:
  - host: $CODE_SERVER_DOMAIN
    http:
...

首先，你将letsencrypt-staging 作为先决条件的一部分创建的 ClusterIssuer 指定为将用于为此 Ingress 提供证书的颁发者。然后，在该tls部分中，你指定应该保护的确切域，以及将持有这些证书的Secret的名称。

通过运行以下命令将更改应用到集群：

envsubst < code-server.yaml | kubectl apply -f -

输出将如下所示：

namespace/code-server unchanged
ingress.networking.k8s.io/code-server configured
service/code-server unchanged
deployment.apps/code-server unchanged

配置和完全应用证书需要几分钟时间。你可以通过观察以下命令的输出来跟踪进度：

kubectl describe certificate  -n code-server

完成后，输出的结尾类似于以下内容：

Events:
  Type    Reason     Age    From                                       Message
  ----    ------     ----   ----                                       -------
  Normal  Issuing    5m     cert-manager-certificates-trigger          Issuing certificate as Secret does not exist
  Normal  Generated  5m     cert-manager-certificates-key-manager      Stored new private key in temporary Secret resource "code-server-tls-pqt6n"
  Normal  Requested  5m     cert-manager-certificates-request-manager  Created new CertificateRequest resource "code-server-tls-mqwqq"
  Normal  Issuing    4m18s  cert-manager-certificates-issuing          The certificate has been successfully issued

在本节中，你将探索code-server 接口的一些功能。由于code-server 是运行在云中的Visual Studio代码，因此它具有与独立桌面版相同的界面。

在IDE的左侧，有一排垂直的六个按钮，用于打开侧面板(称为活动栏)中最常用的功能。

现在，你已经在你的 Kubernetes集群上安装了code-server ，这是一个多功能的云IDE。你可以单独处理源代码和文档，也可以与你的团队协作。在你的集群上运行云IDE可以为测试、下载以及更全面或更严格的计算提供更强大的功能。有关更多信息，请参见有关code-server 其他组件的附加功能和详细说明的Visual Studio代码文档。

如果你打算搭建 Gitpod 的 openvscode server ，主要的改变是把yaml文件中的镜像地址改为 gitpod/openvscode-server:latest ，其他配置如域名等做相应调整即可。openvscode server 支持 使用token 限制访问，可以在command 中指定 --connection-token 来限制对 web ide的访问

另一个云 IDE theia 的搭建过程请看这篇文章 - 如何在Kubernetes平台上搭建云IDE Theia ​

原文地址： https://www.digitalocean.com/community/tutorials/how-to-set-up-the-code-server-cloud-ide-platform-on-digitalocean-kubernetes 译文地址： https://blog.csdn.net/hjue/article/details/125790466 译者：多鱼的夏天 译文出自：CSDN开发云翻译计划