跳转至

高级配置

Nocalhost 的开发配置支持多种开发方式，例如 ConfigMap，注释等。

实际上，这些配置方法**也适合**部署配置。 但是，需要通过 K8S Admission Webhook 来实现某些功能。 在 Nocalhost 中，一个称为Nocalhost-Dep的组件扮演此角色，Nocalhost Server将自动为您部署此组件。

if you do not use Nocalhost Server, then additional deployment of Nocalhost Dep is required.

Info

Nocalhost提供哪些部署配置？ 介绍哪些部署配置需要额外部署nocalhost dep.

使用 ConfigMap 进行部署配置

To make a simple deployment configuration is mentioned in Introduction to Deployment Configuration Nocalhost Basic Deployment Configuration. Combining with What configuration methods are supported by Nocalhost-place the configuration in configmap, we can get the configuration:

We have prepared an demo for this, which will automatically deploy Nocalhost Dep, and use the way of ConfigMap to make the deployment configuration.

Using the following commands to try out this demo (trying the Chart package requires ClusterAdmin)

1
git clone https://github.com/nocalhost/bookinfo && git checkout config/example

Then use Helm to install:

1
helm dep build ./charts/bookinfo && helm install bookinfo ./charts/bookinfo

The content of the deployment configuration itself will not be repeated here. let's take a look at charts/bookinfo/templates/nocalhost-app-config.yaml.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
apiVersion: v1
kind: ConfigMap
metadata:
  # [Nocalhost]: nocalhost configmap should be named with dev.nocalhost.config.${appName}
  name: "dev.nocalhost.config.{{ .Release.Name }}"
  # [Nocalhost]: labels {dep-management: nocalhost} is also required
  labels:
    dep-management: nocalhost
  annotations:
    "helm.sh/hook": pre-install
data:
  config: |-
    {{ .Files.Get .Values.nocalhost.config.path | nindent 4 }}

Danger

This ConfigMap requires to apply to Api Server first. For example, in the Helm application scenario, it should be declared as pre-install.

1
2
annotations:
  "helm.sh/hook": pre-install

It introduces .Values.nocalhost.config.path to render the main body of the deployment configuration. The configuration is actually declared in ./charts/bookinfo/example/config-from-cm/nocalhost-full-config.yaml, which is a standard Nocalhost deployment configuration without any additional modification:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
application:
  env:
    - name: APP_ENV_1
      value: EXAMPLE
    - name: APP_ENV_2
      value: EXAMPLE

  services:
    - name: productpage
      serviceType: deployment
      containers:
        - name: productpage
          install:
            env:
              - name: ENV_INJECT_EXAM
                value: BASE

    - name: details
      serviceType: deployment
      containers:
        - install:
            env:
              - name: ENV_INJECT_EXAM
                value: BASE

    - name: ratings
      serviceType: deployment
      dependLabelSelector:
        pods:
          - "productpage"
      containers:
        - install:
            env:
              - name: ENV_INJECT_EXAM
                value: BASE

    - name: reviews
      serviceType: deployment
      dependLabelSelector:
        pods:
          - "productpage"
      containers:
        - install:
            env:
              - name: ENV_INJECT_EXAM
                value: BASE

    - name: authors
      serviceType: deployment
      dependLabelSelector:
        pods:
          - "productpage"
      containers:
        - install:
            env:
              - name: ENV_INJECT_EXAM
                value: BASE

使用注释进行部署配置

The method of usage is exactly the same as Which configuration methods Nocalhost supports-place the configuration in annotations.

Extra attention

Since Annotations closely follow the workload, some configurations at the application level are not supported. Only the configurations under application.services is supported.

Again, use the same demo project:

Use the following commands to get and try out this project (trying the Chart package requires ClusterAdmin)

1
git clone https://github.com/nocalhost/bookinfo && git checkout config/example

Then use Helm to install:

1
helm dep build ./charts/bookinfo && helm install bookinfo ./charts/bookinfo -f ./charts/bookinfo/values-annotation-config.yaml

We specified values-annotation-config.yaml as Values.yaml, which specifies the rendering of the local configuration file to the Annotations of the workload. Take ./charts/bookinfo/templates/microservice-details.yaml as an !!! example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
apiVersion: apps/v1
kind: Deployment
metadata:
  name: details
  {{- if .Values.nocalhost.annotations.path.details }}
  annotations:
    nocalhost.dev: |-
      {{ .Files.Get .Values.nocalhost.annotations.path.details | nindent 6 }}
  {{- end }}
  labels:
    app: details

Helm will render the path configured by .Values.nocalhost.annotations.path.details into yaml, whose content is as follows, that is, ./charts/bookinfo/example/config-from-annotations/details.yaml specified in Values :

1
2
3
4
5
containers:
  - install:
      env:
        - name: ENV_INJECT_EXAM
          value: ANNOTATIONS

如何部署 Nocalhost Dep

我们建议使用Nocalhost Server获取Nocalhost Dep的所有功能。

Danger

即将推出