teleport-plugin-email 차트 레퍼런스
Teleport v18.9teleport-plugin-email Helm 차트는 email Teleport 플러그인을 구성하는 데 사용되며, 사용자가 이메일을 통해 Access Request를 수신할 수 있도록 합니다. GitHub에서 소스를 탐색할 수 있습니다.
teleport-plugin-email Helm 차트는 email Teleport 플러그인을 구성하는 데 사용되며,
사용자가 이메일을 통해 Access Request를 수신할 수 있도록 합니다.
GitHub에서 소스를 탐색할 수 있습니다.
이 레퍼런스는 teleport-plugin-email 차트에서 사용 가능한 값들을 상세히 설명합니다.
영구적인 수정을 가하기 전에 프로덕션 인스턴스, 환경 및/또는 설정을 백업하는 것을 모범 사례로 권장합니다. 이렇게 하면 필요한 경우 기존 상태로 롤백할 수 있습니다.
teleport#
teleport는 플러그인이 Teleport 클러스터에 연결하는 방식을 설명하는
설정을 담고 있습니다.
teleport.address#
| Type | Default |
|---|---|
string |
"" |
teleport.address는 플러그인이 연결하는 Teleport 클러스터의 주소입니다.
이 주소에는 Teleport 클러스터의 도메인 이름과 포트가 모두 포함되어야 합니다.
auth 서버 또는 proxy 서버의 주소 중 하나일 수 있습니다.
예를 들면 다음과 같습니다:
- Proxy에 조인하는 경우:
teleport.example.com:443또는teleport.example.com:3080 - Auth에 조인하는 경우:
teleport-auth.example.com:3025주소가 비어 있으면, 설정된 경우tbot.teleportProxyAddress또는tbot.teleportAuthAddress가 사용됩니다.
teleport.identitySecretName#
| Type | Default |
|---|---|
string |
"" |
teleport.identitySecretName은 Teleport 클러스터에 연결하기 위한 자격 증명을
담고 있는 Kubernetes secret의 이름입니다.
secret은 다음 형식이어야 합니다:
apiVersion: v1
kind: Secret
type: Opaque
metadata:
name: teleport-plugin-identity
data:
auth_id: #...
이러한 자격 증명을 얻는 방법에 대한 자세한 내용은 이메일을 통한 액세스 요청 가이드를 참고하십시오.
teleport.identitySecretPath#
| Type | Default |
|---|---|
string |
"auth_id" |
teleport.identitySecretPath는 teleport.identitySecretName으로 지정된 Kubernetes
secret에서 Teleport 클러스터 연결을 위한 자격 증명을 담고 있는 키입니다.
secret의 경로가 "auth_id"인 경우,
이 필드는 생략할 수 있습니다.
mailgun#
mailgun은 mailgun 전송 파라미터를 설정합니다.
mailgun 또는 smtp 중 하나는 반드시 설정해야 합니다.
Mailgun 키는 다음과 같이 전달할 수 있습니다:
mailgun.privateKey를 설정하여 차트 Values를 통해mailgun.privateKeyFromSecret을 설정하여 기존 Kubernetes Secret을 통해
mailgun.enabled#
| Type | Default |
|---|---|
bool |
false |
mailgun.enabled는 플러그인이 Mailgun을 통해 이메일을 전송하도록 합니다.
mailgun.domain#
| Type | Default |
|---|---|
string |
"" |
mailgun.domain은 Mailgun이 이메일을 전송할 도메인을 설정합니다.
mailgun이 활성화된 경우 필수입니다.
mailgun.privateKey#
| Type | Default |
|---|---|
string |
"" |
mailgun.privateKey는 플러그인이 Mailgun과 상호작용할 때 사용하는
Mailgun private key입니다. 설정되면 Chart가 Kubernetes Secret을
자동으로 생성합니다.
mailgun.privateKeyFromSecret이 설정된 경우 이 값은 효과가 없습니다.
mailgun.privateKeyFromSecret#
| Type | Default |
|---|---|
string |
"" |
mailgun.privateKeyFromSecret은 Mailgun 키를 담고 있는 Kubernetes Secret의
이름입니다. 이 값이 설정되면, 차트 릴리스를 생성하기 전에
Secret을 먼저 생성해야 합니다.
mailgun.privateKeySecretPath#
| Type | Default |
|---|---|
string |
"mailgunPrivateKey" |
mailgun.privateKeySecretPath는 Mailgun 키를 담고 있는 Kubernetes Secret
키입니다. secret 이름은 mailgun.privateKeyFromSecret을 통해 설정됩니다.
smtp#
smtp는 SMTP 전송 파라미터를 설정합니다.
smtp 또는 smtp 중 하나는 반드시 설정해야 합니다.
SMTP 비밀번호는 다음과 같이 전달할 수 있습니다:
smtp.password를 설정하여 차트 Values를 통해smtp.passwordFromSecret을 설정하여 기존 Kubernetes Secret을 통해
smtp.enabled#
| Type | Default |
|---|---|
bool |
false |
smtp.enabled는 플러그인이 SMTP를 통해 이메일을 전송하도록 합니다.
smtp.host#
| Type | Default |
|---|---|
string |
"" |
smtp.host는 플러그인이 SMTP를 통해 이메일을 전송할 때 사용하는 SMTP 호스트를 설정합니다.
SMTP가 활성화된 경우 필수입니다.
smtp.port#
| Type | Default |
|---|---|
integer |
587 |
smtp.port는 플러그인이 SMTP를 통해 이메일을 전송할 때 사용하는 SMTP 포트를 설정합니다.
smtp.username#
| Type | Default |
|---|---|
string |
"" |
smtp.username은 플러그인이 SMTP를 통해 이메일을 전송할 때 사용하는 SMTP 사용자를 설정합니다.
SMTP가 활성화된 경우 필수입니다.
smtp.password#
| Type | Default |
|---|---|
string |
"" |
smtp.password는 플러그인이 SMTP를 통해 이메일을 전송할 때 사용하는 SMTP 비밀번호를 설정합니다.
설정되면 Chart가 Kubernetes Secret을 자동으로 생성합니다.
smtp.passwordFromSecret이 설정된 경우 이 값은 효과가 없습니다.
smtp.passwordFromSecret#
| Type | Default |
|---|---|
string |
"" |
smtp.passwordFromSecret은 SMTP 비밀번호를 담고 있는 Kubernetes Secret의
이름입니다. 이 값이 설정되면, 차트 릴리스를 생성하기 전에
Secret을 먼저 생성해야 합니다.
smtp.passwordSecretPath#
| Type | Default |
|---|---|
string |
"smtpPassword" |
smtp.passwordSecretPath는 SMTP 비밀번호를 담고 있는 Kubernetes Secret
키입니다. secret 이름은 smtp.passwordFromSecret을 통해 설정됩니다.
smtp.starttlsPolicy#
| Type | Default |
|---|---|
string |
"mandatory" |
smtp.starttlsPolicy는 플러그인이 SMTP를 통해 이메일을 전송할 때 사용하는
SMTP StartTLS 정책을 설정합니다.
delivery#
delivery는 이메일 플러그인의 전달 옵션을 설정합니다.
delivery.sender#
| Type | Default |
|---|---|
string |
"" |
delivery.sender는 이메일 발신자입니다.
delivery.recipients#
| Type | Default |
|---|---|
list[string] |
[] |
delivery.recipients는 DEPRECATED되었습니다.
이메일 수신자 목록입니다. 대신 roleToRecipients를 사용해야 합니다.
roleToRecipients#
| Type | Default |
|---|---|
object |
{} |
roleToRecipients는 요청된 role 이름을 플러그인이 알림을 보낼 이메일
수신자 목록에 매핑합니다.
일치하는 role을 찾지 못한 경우를 대비해 *에 대한 매핑을 반드시 포함해야 합니다.
Example value:
roleToRecipients:
"*": "admin@example.com"
dev:
- "dev-team+accessrequest@example.com"
- "devops@example.com"
log#
log는 플러그인 로깅을 제어합니다.
log.severity#
| Type | Default |
|---|---|
string |
"INFO" |
log.severity는 Teleport 프로세스의 로그 레벨입니다.
사용 가능한 로그 레벨은 DEBUG, INFO, WARN, ERROR입니다.
기본값은 INFO이며, 프로덕션 환경에서 권장됩니다.
DEBUG는 최초 설정 시 또는 디버깅을 위해 더 자세한 로그를 확인할 때 유용합니다.
log.output#
| Type | Default |
|---|---|
string |
"stdout" |
log.output은 Teleport 프로세스의 출력 대상을 설정합니다.
내장 값인 stdout, stderr 중 하나로 설정할 수 있습니다.
이 값은 로그를 파일에 기록하기 위해 파일 경로(예: /var/log/teleport.log)로
설정할 수도 있습니다. 다만 일부 서비스 시작 메시지는 복원력을 위해
여전히 stderr로 출력된다는 점에 유의하십시오.
tbot#
tbot은 플러그인이 Teleport에 연결하기 위한 자격 증명을 획득하고 갱신하는
선택적 tbot 배포를 제어합니다.
여기에는 기본값과 필수 값만 설명되어 있으며, 지원되는 값의 전체 목록은 tbot 차트 레퍼런스를
참고하십시오.
tbot.enabled#
| Type | Default |
|---|---|
bool |
false |
tbot.enabled는 tbot을 메일 플러그인과 함께 배포할지 여부를 제어합니다.
tbot.clusterName#
| Type | Default |
|---|---|
string |
"" |
tbot.clusterName은 tbot과 메일 플러그인이 조인할 Teleport 클러스터의 이름입니다.
tbot이 활성화된 경우 이 값을 설정하는 것은 필수입니다.
tbot.teleportProxyAddress#
| Type | Default |
|---|---|
string |
"" |
tbot.teleportProxyAddress는 봇이 연결할 teleport Proxy Service 주소입니다.
여기에는 포트 번호가 포함되어야 하며, Proxy Service의 경우 보통 443 또는 3080입니다.
Proxy Service에 연결하는 것이 Teleport에 연결하는 가장 일반적이고 권장되는 방법입니다.
Teleport Enterprise (Cloud)에 연결하려면 이 값이 필수입니다.
이 설정은 teleportAuthAddress와 상호 배타적입니다.
예를 들면 다음과 같습니다:
tbot:
teleportProxyAddress: "test.teleport.sh:443"
tbot.teleportAuthAddress#
| Type | Default |
|---|---|
string |
"" |
tbot.teleportAuthAddress는 봇이 연결할 teleport Auth Service 주소입니다.
여기에는 포트 번호가 포함되어야 하며, Auth Service의 경우 보통 3025입니다. 직접 Auth Service 연결은
봇을 teleport-cluster Helm 릴리스와 동일한 Kubernetes 클러스터에 배포하고
Auth Service에 직접 접근할 수 있을 때 사용해야 합니다.
그렇지 않은 경우 Proxy Service를 통해 연결하는 것이 좋습니다.
이 설정은 teleportProxyAddress와 상호 배타적입니다.
예를 들면 다음과 같습니다:
teleportAuthAddress: "teleport-auth.teleport-namespace.svc.cluster.local:3025"
tbot.joinMethod#
| Type | Default |
|---|---|
string |
"kubernetes" |
tbot.joinMethod은 tbot이 Teleport 클러스터에 조인하는 방식을 설명합니다.
지원되는 값의 목록과 자세한 설명은 join method 레퍼런스를 참고하십시오.
annotations#
annotations는 차트가 생성하는 여러 Kubernetes 객체에 적용할
annotation을 담고 있습니다. 자세한 내용은 Kubernetes annotation
문서를
참고하십시오.
annotations.config#
| Type | Default |
|---|---|
object |
{} |
annotations.config는 차트가 생성하는 ConfigMap 리소스에 적용되는
Kubernetes annotation을 담고 있습니다.
annotations.deployment#
| Type | Default |
|---|---|
object |
{} |
annotations.deployment는 차트가 생성하는 Deployment 또는 StatefulSet 리소스에
적용되는 Kubernetes annotation을 담고 있습니다.
annotations.pod#
| Type | Default |
|---|---|
object |
{} |
annotations.pod는 차트가 생성하는 Pod 리소스에 적용되는
Kubernetes annotation을 담고 있습니다.
annotations.secret#
| Type | Default |
|---|---|
object |
{} |
annotations.secret은 차트가 생성하는 Secret 리소스에 적용되는
Kubernetes annotation을 담고 있습니다.
joinTokenSecret.create가 false인 경우 효과가 없습니다.
image#
image는 차트가 생성하는 플러그인 pod에 사용되는 컨테이너 이미지를 설정합니다.
Teleport에서 게시한 이미지 대신 직접 만든 플러그인 이미지를 사용하도록 재정의할 수 있습니다.
image.repository#
| Type | Default |
|---|---|
string |
"public.ecr.aws/gravitational/teleport-plugin-email" |
image.repository는 이미지 저장소입니다.
image.pullPolicy#
| Type | Default |
|---|---|
string |
"IfNotPresent" |
image.pullPolicy는 Kubernetes 이미지 pull 정책입니다.
image.tag#
| Type | Default |
|---|---|
string |
"" |
image.tag는 이미지 태그를 재정의하며, 기본값은 차트 appVersion입니다.
일반적으로 Teleport 플러그인의 버전은 차트의 버전과 일치합니다. 차트 버전 15.0.0을 설치하면 플러그인 버전 15.0.0을 사용하게 됩니다. 플러그인 업그레이드는 차트를 업그레이드하여 수행합니다.
image.tag는 개발 및 커스텀 태그를 위한 것입니다. 일반적인 배포에서 플러그인
버전을 제어하는 데 사용해서는 안 됩니다. 이 차트는 특정 플러그인 버전을
실행하도록 설계되었습니다. 다른 버전을 실행하려고 하면 호환성 문제가
발생합니다.
Teleport 플러그인 버전 X.Y.Z를 실행하려면, 대신
helm install --version X.Y.Z를 사용해야 합니다.
imagePullSecrets#
| Type | Default |
|---|---|
list |
[] |
imagePullSecrets는 프라이빗 Docker 레지스트리에 접근할 때 선택적으로 사용할 수
있는 인증 토큰을 담고 있는 secret 목록입니다.
자세한 내용은 Kubernetes 레퍼런스를 참고하십시오.
podSecurityContext#
| Type | Default |
|---|---|
object |
{} |
podSecurityContext는 차트가 생성하는 모든 pod에 대한 pod security context를 설정합니다.
자세한 내용은 Kubernetes 문서를
참고하십시오.
security context를 해제하려면 null 또는 ~로 설정하십시오.
securityContext#
| Type | Default |
|---|---|
object |
{} |
securityContext는 차트가 생성하는 모든 pod에 대한 컨테이너 security context를 설정합니다.
자세한 내용은 Kubernetes 문서를
참고하십시오.
security context를 해제하려면 null 또는 ~로 설정하십시오.
resources#
| Type | Default |
|---|---|
object |
{} |
resources는 차트가 생성하는 모든 pod에 대한 리소스 requests/limits를 설정합니다.
자세한 내용은 Kubernetes 문서를
참고하십시오.
nodeSelector#
| Type | Default |
|---|---|
object |
{} |
nodeSelector는 차트가 생성하는 모든 pod에 대한 node selector를 설정합니다.
자세한 내용은 Kubernetes 문서를
참고하십시오.
tolerations#
| Type | Default |
|---|---|
list |
[] |
tolerations는 차트가 생성하는 모든 pod에 대한 toleration을 설정합니다.
자세한 내용은 Kubernetes 문서를
참고하십시오.
affinity#
| Type | Default |
|---|---|
object |
{} |
affinity는 차트가 생성하는 모든 pod에 대한 affinity를 설정합니다.
자세한 내용은 Kubernetes 문서를
참고하십시오.