6.8. Service Binding Operator를 사용한 바인딩 워크로드
애플리케이션 개발자는 바인딩 보안을 사용하여 워크로드를 하나 이상의 백업 서비스에 바인딩해야 합니다. 이 시크릿은 워크로드에서 사용할 정보를 저장하기 위해 생성됩니다.
예를 들어 연결하려는 서비스가 이미 바인딩 데이터를 노출하고 있다고 가정합니다. 이 경우 ServiceBinding
CR(사용자 정의 리소스)과 함께 워크로드를 사용해야 합니다. 이 ServiceBinding
CR을 사용하면 워크로드에서 바인딩할 서비스의 세부 정보와 함께 바인딩 요청을 보냅니다.
ServiceBinding
CR의 예
apiVersion: binding.operators.coreos.com/v1alpha1 kind: ServiceBinding metadata: name: spring-petclinic-pgcluster namespace: my-petclinic spec: services: 1 - group: postgres-operator.crunchydata.com version: v1beta1 kind: PostgresCluster name: hippo application: 2 name: spring-petclinic group: apps version: v1 resource: deployments
이전 예에 표시된 대로 ConfigMap
또는 Secret
자체를 바인딩 데이터 소스로 사용할 서비스 리소스로 직접 사용할 수도 있습니다.
6.8.1. 전략 이름 지정
이름 지정 전략은 binding.operators.coreos.com
API 그룹에만 사용할 수 있습니다.
이름 지정 전략에서는 Go 템플릿을 사용하여 서비스 바인딩 요청을 통해 사용자 정의 바인딩 이름을 정의하는 데 도움이 됩니다. 이름 지정 전략은 ServiceBinding
CR(사용자 정의 리소스)의 매핑을 포함한 모든 속성에 적용됩니다.
백업 서비스는 바인딩 이름을 워크로드에 파일 또는 환경 변수로 프로젝트를 생성합니다. 워크로드에 특정 형식의 예상 바인딩 이름이 필요하지만 백업 서비스에서 바인딩 이름을 예상하는 경우 이름 지정 전략을 사용하여 바인딩 이름을 변경할 수 없습니다.
사전 정의된 후 처리 기능
이름 지정 전략을 사용하는 동안 워크로드의 기대치 또는 요구 사항에 따라 다음과 같이 사전 정의된 후 처리 기능을 사용하여 문자 문자열을 변환할 수 있습니다.
-
대문자
: 문자 문자열을 대문자 또는 대문자로 변환합니다. -
소문자
: 문자 문자열을 소문자로 변환합니다. -
title
: 특정 마이너 단어를 제외하고 각 단어의 첫 글자가 대문자로 지정된 문자 문자열을 변환합니다.
사전 정의된 이름 지정 전략
주석을 통해 선언된 바인딩 이름은 다음과 같이 사전 정의된 이름 지정 전략에 따라 프로젝션이 워크로드에 도달하기 전에 이름에 대해 처리됩니다.
none
: 적용되면 바인딩 이름에 변경 사항이 없습니다.예제
템플릿 컴파일 후 바인딩 이름은
{{ .name }}
양식을 사용합니다.host: hippo-pgbouncer port: 5432
upper
:namingStrategy
가 정의되지 않은 경우 적용됩니다. 적용되면 바인딩 이름 키의 모든 문자 문자열을 대문자 또는 대문자로 변환합니다.예제
템플릿 컴파일 후 바인딩 이름은
{{ .service.kind | upper}}_{{ .name | upper }}
양식을 사용합니다.DATABASE_HOST: hippo-pgbouncer DATABASE_PORT: 5432
워크로드에 다른 형식이 필요한 경우 사용자 지정 이름 지정 전략을 정의하고 접두사 및 구분 기호(예:
PORT_DATABASE
)를 사용하여 바인딩 이름을 변경할 수 있습니다.
-
바인딩 이름이 파일로 프로젝션되면 기본적으로 사전 정의된
없음 이름
지정 전략이 적용되고 바인딩 이름은 변경되지 않습니다. -
바인딩 이름이 환경 변수로 예상되고
namingStrategy
가 정의되지 않은 경우 기본적으로 사전 정의된대문자
이름 지정 전략이 적용됩니다. - 사용자 정의 바인딩 이름 및 사전 정의된 후 처리 함수의 다양한 조합을 사용하여 사용자 정의 이름 지정 전략을 정의하여 사전 정의된 이름 지정 전략을 재정의할 수 있습니다.
6.8.2. 고급 바인딩 옵션
ServiceBinding
CR(사용자 정의 리소스)을 정의하여 다음 고급 바인딩 옵션을 사용할 수 있습니다.
-
바인딩 이름 변경: 이 옵션은
binding.operators.coreos.com
API 그룹에만 사용할 수 있습니다. -
사용자 정의 바인딩 데이터 구성: 이 옵션은
binding.operators.coreos.com
API 그룹에만 사용할 수 있습니다. -
레이블 선택기를 사용하는 바인딩 워크로드: 이 옵션은
binding.operators.coreos.com
및servicebinding.io
API 그룹 모두에 사용할 수 있습니다.
6.8.2.1. 워크로드에 프로젝션하기 전에 바인딩 이름 변경
ServiceBinding
CR의 .spec.namingStrategy
속성에서 바인딩 이름을 변경하는 규칙을 지정할 수 있습니다. 예를 들어 PostgreSQL 데이터베이스에 연결하는 Spring PetClinic 샘플 애플리케이션을 고려해 보십시오. 이 경우 PostgreSQL 데이터베이스 서비스는 바인딩에 사용할 데이터베이스의 호스트
및 포트
필드를 노출합니다. Spring PetClinic 샘플 애플리케이션은 바인딩 이름을 통해 이 노출된 바인딩 데이터에 액세스할 수 있습니다.
예: ServiceBinding
CR의 Spring PetClinic 샘플 애플리케이션
... application: name: spring-petclinic group: apps version: v1 resource: deployments ...
예: ServiceBinding
CR의 PostgreSQL 데이터베이스 서비스
... services: - group: postgres-operator.crunchydata.com version: v1beta1 kind: PostgresCluster name: hippo ...
namingStrategy
가 정의되지 않고 바인딩 이름이 환경 변수로 프로젝션되는 경우 백업 서비스의 host: hippo-pgbouncer
값이 표시되고 예상 환경 변수가 다음 예와 같이 표시됩니다.
예제
DATABASE_HOST: hippo-pgbouncer
다음과 같습니다.
|
|
| 바인딩 이름을 지정합니다. |
POSTGRESQL_{{ .service.kind | upper }}_{{ .name | upper }}_ENV
이름 지정 전략을 적용한 후 서비스 바인딩 요청에 의해 준비된 사용자 정의 바인딩 이름 목록이 다음 예와 같이 표시됩니다.
예제
POSTGRESQL_DATABASE_HOST_ENV: hippo-pgbouncer POSTGRESQL_DATABASE_PORT_ENV: 5432
다음 항목은 POSTGRESQL_{{ .service.kind | upper }}_{{ .name | upper }}_ENV
이름 지정 전략에 정의된 표현식을 설명합니다.
-
.name
: 백업 서비스에 의해 노출되는 바인딩 이름을 나타냅니다. 이전 예에서 바인딩 이름은HOST
및PORT
입니다. -
.service.kind
: 바인딩 이름이 이름 지정 전략을 사용하여 변경된 서비스 리소스를 나타냅니다. -
upper
: Go 템플릿 문자열을 컴파일하는 동안 문자 문자열을 post-process하는 데 사용되는 문자열 함수입니다. -
POSTGRESQL
: 사용자 정의 바인딩 이름 접두사입니다. -
ENV
: 사용자 정의 바인딩 이름의 Suffix입니다.
이전 예제와 유사하게 namingStrategy
에서 문자열 템플릿을 정의하여 서비스 바인딩 요청에서 바인딩 이름의 각 키를 준비하는 방법을 정의할 수 있습니다.
6.8.2.2. 사용자 정의 바인딩 데이터 구성
애플리케이션 개발자는 다음과 같은 상황에서 사용자 정의 바인딩 데이터를 구성할 수 있습니다.
- 백업 서비스는 바인딩 데이터를 노출하지 않습니다.
- 노출된 값은 워크로드에서 예상대로 필요한 형식으로 사용할 수 없습니다.
예를 들어 백업 서비스 CR에서 호스트, 포트 및 데이터베이스 사용자를 바인딩 데이터로 노출하지만 워크로드에는 바인딩 데이터를 연결 문자열로 사용해야 하는 경우를 고려해 보십시오. 백업 서비스를 나타내는 Kubernetes 리소스의 속성을 사용하여 사용자 정의 바인딩 데이터를 구성할 수 있습니다.
예제
apiVersion: binding.operators.coreos.com/v1alpha1 kind: ServiceBinding metadata: name: spring-petclinic-pgcluster namespace: my-petclinic spec: services: - group: postgres-operator.crunchydata.com version: v1beta1 kind: PostgresCluster name: hippo 1 id: postgresDB 2 - group: "" version: v1 kind: Secret name: hippo-pguser-hippo id: postgresSecret application: name: spring-petclinic group: apps version: v1 resource: deployments mappings: ## From the database service - name: JDBC_URL value: 'jdbc:postgresql://{{ .postgresDB.metadata.annotations.proxy }}:{{ .postgresDB.spec.port }}/{{ .postgresDB.metadata.name }}' ## From both the services! - name: CREDENTIALS value: '{{ .postgresDB.metadata.name }}{{ translationService.postgresSecret.data.password }}' ## Generate JSON - name: DB_JSON 3 value: {{ json .postgresDB.status }} 4
6.8.2.3. 라벨 선택기를 사용하여 워크로드 바인딩
라벨 선택기를 사용하여 바인딩할 워크로드를 지정할 수 있습니다. 라벨 선택기를 사용하여 워크로드를 선택하여 서비스 바인딩을 선언하면 Service Binding Operator는 지정된 라벨 선택기와 일치하는 새 워크로드를 주기적으로 찾고 바인딩하려고 합니다.
예를 들어 클러스터 관리자는 ServiceBinding
CR에 적절한 labelSelector
필드를 설정하여 environment: production
라벨을 사용하여 네임스페이스의 모든 배포에 서비스를 바인딩할 수 있습니다. 이를 통해 Service Binding Operator에서 각 워크로드를 하나의
ServiceBinding
CR로 바인딩할 수 있습니다.
binding.operators.coreos.com/v1alpha1
API의 ServiceBinding
CR 예
apiVersion: binding.operators.coreos.com/v1alpha1
kind: ServiceBinding
metadata:
name: multi-application-binding
namespace: service-binding-demo
spec:
application:
labelSelector: 1
matchLabels:
environment: production
group: apps
version: v1
resource: deployments
services:
group: ""
version: v1
kind: Secret
name: super-secret-data
- 1
- 바인딩된 워크로드를 지정합니다.
servicebinding.io
API의 ServiceBinding
CR의 예
apiVersion: servicebindings.io/v1beta1
kind: ServiceBinding
metadata:
name: multi-application-binding
namespace: service-binding-demo
spec:
workload:
selector: 1
matchLabels:
environment: production
apiVersion: app/v1
kind: Deployment
service:
apiVersion: v1
kind: Secret
name: super-secret-data
- 1
- 바인딩된 워크로드를 지정합니다.
다음 필드 쌍을 정의하는 경우 Service Binding Operator는 바인딩 작업을 거부하고 오류를 생성합니다.
-
binding.operators.coreos.com/v1alpha1
API의name
및labelSelector
필드입니다. -
servicebinding.io
API(Spec API)의name
및selector
필드입니다.
다시 바인딩 동작 이해
바인딩에 성공한 후 이름
필드를 사용하여 워크로드를 식별하는 경우를 고려하십시오. 해당 워크로드를 삭제하고 다시 생성하는 경우 ServiceBinding
조정기에서 워크로드를 다시 바인딩하지 않으며 Operator는 바인딩 데이터를 워크로드에 project할 수 없습니다. 그러나 labelSelector
필드를 사용하여 워크로드를 식별하는 경우 ServiceBinding
조정기에서 워크로드를 다시 바인딩하고 Operator는 바인딩 데이터를 생성합니다.
6.8.3. PodSpec과 호환되지 않는 보조 워크로드 바인딩
서비스 바인딩의 일반적인 시나리오에는 백업 서비스, 워크로드(배포) 및 Service Binding Operator를 구성하는 작업이 포함됩니다. PodSpec과 호환되지 않고 기본 워크로드(Deployment)와 Service Binding Operator 간의 보조 워크로드(애플리케이션 Operator일 수도 있음)와 관련된 시나리오를 고려하십시오.
이러한 보조 워크로드 리소스의 경우 컨테이너 경로의 위치는 임의적입니다. 서비스 바인딩의 경우 CR의 보조 워크로드가 PodSpec과 호환되지 않는 경우 컨테이너 경로의 위치를 지정해야 합니다. 이렇게 하면 Pod 내부에 바인딩 데이터를 원하지 않는 경우와 같이 ServiceBinding
CR(사용자 정의 리소스)의 보조 워크로드에 지정된 컨테이너 경로에 바인딩 데이터를 프로젝트에 바인딩합니다.
Service Binding Operator에서는 컨테이너 또는 시크릿이 워크로드 내에 있는 위치의 경로를 구성하고 사용자 정의 위치에서 이러한 경로를 바인딩할 수 있습니다.
6.8.3.1. 컨테이너 경로의 사용자 정의 위치 구성
Service Binding Operator가 바인딩 데이터를 환경 변수로 작업할 때 이 사용자 정의 위치는 binding.operators.coreos.com
API 그룹에 사용할 수 있습니다.
PodSpec과 호환되지 않고 spec.containers
경로에 있는 컨테이너가 있는 보조 워크로드 CR을 고려하십시오.
예: 보조 워크로드 CR
apiVersion: "operator.sbo.com/v1" kind: SecondaryWorkload metadata: name: secondary-workload spec: containers: - name: hello-world image: quay.io/baijum/secondary-workload:latest ports: - containerPort: 8080
프로세스
ServiceBinding
CR에 값을 지정하고 이 경로를spec.application.bindingPath.containersPath
사용자 지정 위치에 바인딩하여spec.containers
경로를 구성합니다.예: 사용자 정의 위치의
spec.containers
경로가 있는ServiceBinding
CRapiVersion: binding.operators.coreos.com/v1alpha1 kind: ServiceBinding metadata: name: spring-petclinic-pgcluster spec: services: - group: postgres-operator.crunchydata.com version: v1beta1 kind: PostgresCluster name: hippo id: postgresDB - group: "" version: v1 kind: Secret name: hippo-pguser-hippo id: postgresSecret application: 1 name: spring-petclinic group: apps version: v1 resource: deployments application: 2 name: secondary-workload group: operator.sbo.com version: v1 resource: secondaryworkloads bindingPath: containersPath: spec.containers 3
컨테이너 경로의 위치를 지정하면 Service Binding Operator에서 ServiceBinding
CR의 보조 워크로드에 지정된 컨테이너 경로에서 사용할 수 있게 되는 바인딩 데이터를 생성합니다.
다음 예제에서는 envFrom
및 secretRef
필드가 있는 spec.containers
경로를 보여줍니다.
예: envFrom
및 secretRef
필드가 있는 보조 워크로드 CR
apiVersion: "operator.sbo.com/v1" kind: SecondaryWorkload metadata: name: secondary-workload spec: containers: - env: 1 - name: ServiceBindingOperatorChangeTriggerEnvVar value: "31793" envFrom: - secretRef: name: secret-resource-name 2 image: quay.io/baijum/secondary-workload:latest name: hello-world ports: - containerPort: 8080 resources: {}
6.8.3.2. 보안 경로의 사용자 정의 위치 구성
Service Binding Operator가 바인딩 데이터를 환경 변수로 작업할 때 이 사용자 정의 위치는 binding.operators.coreos.com
API 그룹에 사용할 수 있습니다.
spec.secret
경로의 보안만 있는 PodSpec과 호환되지 않는 보조 워크로드 CR을 고려하십시오.
예: 보조 워크로드 CR
apiVersion: "operator.sbo.com/v1" kind: SecondaryWorkload metadata: name: secondary-workload spec: secret: ""
프로세스
ServiceBinding
CR에 값을 지정하고spec.application.bindingPath.secretPath
사용자 정의 위치에서 이 경로를 바인딩하여spec.secret
경로를 구성합니다.예: 사용자 정의 위치의
spec.secret
경로가 있는ServiceBinding
CRapiVersion: binding.operators.coreos.com/v1alpha1 kind: ServiceBinding metadata: name: spring-petclinic-pgcluster spec: ... application: 1 name: secondary-workload group: operator.sbo.com version: v1 resource: secondaryworkloads bindingPath: secretPath: spec.secret 2 ...
보안 경로의 위치를 지정하면 Service Binding Operator에서 ServiceBinding
CR의 보조 워크로드에 지정된 보안 경로에서 사용할 수 있게 되는 바인딩 데이터를 생성합니다.
다음 예제에서는 binding-request
값이 있는 spec.secret
경로를 보여줍니다.
예: binding-request
값이 있는 보조 워크로드 CR
...
apiVersion: "operator.sbo.com/v1"
kind: SecondaryWorkload
metadata:
name: secondary-workload
spec:
secret: binding-request-72ddc0c540ab3a290e138726940591debf14c581 1
...
- 1
- Service Binding Operator가 생성하는
Secret
리소스의 고유 이름입니다.
6.8.3.3. 워크로드 리소스 매핑
-
워크로드 리소스 매핑은 API 그룹
binding.operators.coreos.com
및servicebinding.io
둘 다에 대해ServiceBinding
CR(사용자 정의 리소스)의 보조 워크로드에 사용할 수 있습니다. -
servicebinding.io
API 그룹에서만ClusterWorkloadResourceMapping
리소스를 정의해야 합니다. 그러나ClusterWorkloadResourceMapping
리소스는binding.operators.coreos.com
및servicebinding.io
API 그룹 모두에서ServiceBinding
리소스와 상호 작용합니다.
컨테이너 경로에 구성 방법을 사용하여 사용자 정의 경로 위치를 구성할 수 없는 경우 바인딩 데이터를 예상해야 하는 위치를 정확하게 정의할 수 있습니다. servicebinding.io
API 그룹에서 ClusterWorkloadResourceMapping
리소스를 정의하여 지정된 워크로드 유형에 대한 바인딩 데이터를 프로젝트의 위치를 지정합니다.
다음 예제에서는 CronJob.batch/v1
리소스의 매핑을 정의하는 방법을 보여줍니다.
예: CronJob.batch/v1
리소스에 대한 매핑
apiVersion: servicebinding.io/v1beta1 kind: ClusterWorkloadResourceMapping metadata: name: cronjobs.batch 1 spec: versions: - version: "v1" 2 annotations: .spec.jobTemplate.spec.template.metadata.annotations 3 containers: - path: .spec.jobTemplate.spec.template.spec.containers[*] 4 - path: .spec.jobTemplate.spec.template.spec.initContainers[*] name: .name 5 env: .env 6 volumeMounts: .volumeMounts 7 volumes: .spec.jobTemplate.spec.template.spec.volumes 8
- 1
- 매핑된 워크로드 리소스의
plural.group
으로 자격을 지정해야 하는ClusterWorkloadResourceMapping
리소스의 이름입니다. - 2
- 매핑되는 리소스의 버전입니다. 지정되지 않은 모든 버전은 "*" 와일드카드와 일치할 수 있습니다.
- 3
- 선택 사항: 고정 JSONPath로 지정된 Pod의
.annotations
필드의 식별자입니다. 기본값은.spec.template.spec.annotations
입니다. - 4
- JSONPath로 지정된 Pod의
.containers
및.initContainers
필드의 식별자입니다.containers
필드 아래의 항목이 정의되지 않은 경우 Service Binding Operator의 기본값은.spec.template.spec.containers[*]
및.spec.template.spec.initContainers[\*]
.spec.template.initContainers[\*] 로 기본값으로 설정되어 있습니다. 그러나 항목을 지정하는 경우.path
필드를 정의해야 합니다. - 5
- 선택 사항: 고정된 JSONPath로 지정된 컨테이너의
.name
필드의 식별자입니다. 기본값은.name
입니다. - 6
- 선택 사항: 고정된 JSONPath로 지정된 컨테이너의
.env
필드의 식별자입니다. 기본값은.env
입니다. - 7
- 선택 사항: 고정된 JSONPath로 지정된 컨테이너의
.volumeMounts
필드의 식별자입니다. 기본값은.volumeMounts
입니다. - 8
- 선택 사항: 고정 JSONPath로 지정된 Pod의
.volumes
필드의 식별자입니다. 기본값은.spec.template.spec.volumes
입니다.
이 컨텍스트에서 고정 JSONPath는 다음 작업만 허용하는 JSONPath grammar의 하위 집합입니다.
-
필드 조회:
.spec.template
-
배열 인덱싱:
.spec['template']
다른 모든 작업은 허용되지 않습니다.
-
필드 조회:
-
이러한 필드의 대부분은 선택 사항입니다. Service Binding Operator를 지정하지 않으면 기본값이
PodSpec
리소스와 호환되는 것으로 가정합니다. -
Service Binding Operator를 사용하려면 이러한 각 필드가 Pod 배포의 해당 필드와 구조적으로 같아야 합니다. 예를 들어 워크로드 리소스의
.env
필드의 콘텐츠는 Pod 리소스의.env
필드와 동일한 데이터 구조를 허용할 수 있어야 합니다. 그렇지 않으면 이러한 워크로드에 바인딩 데이터를 프로젝션하면 Service Binding Operator에서 예기치 않은 동작이 발생할 수 있습니다.
binding.operators.coreos.com
API 그룹과 관련된 동작
ClusterWorkloadResourceMapping
리소스가 binding.operators.coreos.com
API 그룹에서 ServiceBinding
리소스와 상호 작용할 때 다음 동작을 기대할 수 있습니다.
-
bindAsFiles: false
플래그 값이 있는ServiceBinding
리소스가 이러한 매핑 중 하나와 함께 생성되는 경우 환경 변수가 해당ClusterWorkloadResourceMapping
리소스에 지정된 각경로
필드 아래에 있는.envFrom
필드에 프로젝션됩니다. 클러스터 관리자는 바인딩 목적으로
ServiceBinding.bindings.coreos.com
리소스에서ClusterWorkloadResourceMapping
리소스와.spec.application.bindingPath.containersPath
필드를 모두 지정할 수 있습니다.Service Binding Operator는
ClusterWorkloadResourceMapping
리소스와.spec.application.bindingPath.containersPath
필드 모두에 지정된 위치에 데이터를 바인딩하는 프로젝트를 시도합니다. 이 동작은path: $containersPath
특성과 함께 해당ClusterWorkloadResourceMapping
리소스에 컨테이너 항목을 추가하는 것과 동일합니다. 다른 모든 값은 기본값을 사용합니다.
6.8.4. 백업 서비스에서 워크로드 바인딩 해제
oc
툴을 사용하여 백업 서비스에서 워크로드를 바인딩 해제할 수 있습니다.
백업 서비스에서 워크로드를 바인딩 해제하려면 연결된
ServiceBinding
CR(사용자 정의 리소스)을 삭제합니다.$ oc delete ServiceBinding <.metadata.name>
예제
$ oc delete ServiceBinding spring-petclinic-pgcluster
다음과 같습니다.
spring-petclinic-pgcluster
ServiceBinding
CR의 이름을 지정합니다.