SonarQube Connector 自动创建 Tekton Task
一个 Tekton Task,可在单次运行中为集群上的 租户级 SonarQube Connector 提供并维护。该 Task 会创建(或复用)SonarQube 侧身份,限定租户的项目 key 空间,生成可刷新用户令牌,并将租户 sonarqube Connector 以及其令牌 Secret 写入目标命名空间。
该 Task 是幂等的,并且可以安全地按周期调度:用户令牌会在每次运行时刷新,并在到期前自动续期。
有关 operator 操作流程——前置条件、接入、轮换和下线——请参阅
使用该 Task。
安装
connectors-operator 仅安装 SonarQube 框架(CRD、RBAC、ConnectorClass、ResourceInterface)。Task 本身需要按照 Tekton catalog 约定,由用户单独应用。
请选择一个集群可访问的 registry mirror,以及你希望安装该 Task 的命名空间,然后应用下面的 manifest。生成的内容块会通过
hack/sync_sonarqube_connector_automatic_creation_task_doc.sh
与
cmd/kodata/connectors-sonarqube-tektoncd/<version>/install.yaml
保持同步。
REGISTRY:托管
sonarqube-connector-automatic-creation 工具镜像(以及任何镜像化 catalog 镜像)的 registry。例如 registry.alauda.cn:60070。
TARGET_NS:你希望安装该 Task 的命名空间。
export REGISTRY=<your-registry>
export TARGET_NS=<target-namespace>
cat <<'EOF' | envsubst '${REGISTRY} ${TARGET_NS}' | kubectl apply -f -
apiVersion: tekton.dev/v1
kind: Task
metadata:
annotations:
style.tekton.dev/descriptors: |
- path: params.connector
x-descriptors:
- urn:alm:descriptor:label:en:Connector
- 'urn:alm:descriptor:description:en:Target tenant SonarQube Connector to create or update, in <namespace>/<name> format, for example connectors-management/acme-sonarqube'
- 'urn:alm:descriptor:tooltip:en:The token Secret is created in the same namespace as the Connector'
- urn:alm:descriptor:com.tectonic.ui:text
- urn:alm:descriptor:com.tectonic.ui:validation:required
- path: params.tenant
x-descriptors:
- urn:alm:descriptor:label:en:Tenant
- 'urn:alm:descriptor:description:en:Tenant identifier. Used to derive default names for the SonarQube user and permission template when those fields are left empty'
- urn:alm:descriptor:com.tectonic.ui:text
- urn:alm:descriptor:com.tectonic.ui:validation:required
- path: params.projectPattern
x-descriptors:
- urn:alm:descriptor:label:en:Project Key Pattern
- 'urn:alm:descriptor:description:en:Regular expression matching the tenant project key space. Used to scope the permission template so it only applies to this tenant. Must not overlap with the patterns used by other tenants'
- 'urn:alm:descriptor:tooltip:en:Example: ^acme-.* to scope this tenant to project keys starting with acme-'
- urn:alm:descriptor:com.tectonic.ui:text
- urn:alm:descriptor:com.tectonic.ui:validation:required
- path: params.templatePermissions
x-descriptors:
- urn:alm:descriptor:label:en:Template Permissions
- 'urn:alm:descriptor:description:en:Project-level permissions granted to the tenant user. The default covers Browse, See Source Code, and Execute Analysis. Do not include admin, otherwise the tenant could change project visibility or delete projects'
- urn:alm:descriptor:com.tectonic.ui:text-array
- path: params.tokenDuration
x-descriptors:
- urn:alm:descriptor:label:en:Token Duration (days)
- 'urn:alm:descriptor:description:en:Validity of the SonarQube user token, in whole days (positive integer). The token is automatically renewed before it expires on each run, so the Task can be scheduled on a recurring basis'
- urn:alm:descriptor:com.tectonic.ui:text
- urn:alm:descriptor:com.tectonic.ui:validation:required
style.tekton.dev/displayParams: connector,tenant,projectPattern,templatePermissions,tokenDuration
tekton.dev/categories: CLI
tekton.dev/displayName: SonarQube Connector Automatic Creation
tekton.dev/icon: data:image/svg+xml;base64,<?xml version="1.0" encoding="UTF-8"?>
<svg width="80px" height="60px" viewBox="0 0 80 60" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
    <title>sonarqube</title>
    <g id="工具链集成" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
        <g id="sonarqube">
            <rect id="Rectangle-16-Copy-17" x="0" y="0" width="80" height="60" rx="2"></rect>
            <g id="Group-66" transform="translate(9.999989, 10.586263)">
                <g id="Group-12" fill="#7C8183">
                    <path d="M3.59969388,23.3516948 C7.11550283,20.9520251 11.9070933,21.8657229 14.2953195,25.3983218 C16.4141166,28.5215697 15.9378452,32.6487871 13.3637663,35.218658 L13.3637663,35.218658 L16.3418618,40.0755824 L13.9772964,41.6879603 L10.9978016,36.8310359 C7.67038953,38.286747 3.67589221,37.215361 1.56065698,34.0884102 C-0.831385559,30.5595142 0.0815951519,25.7513646 3.59969388,23.3516948 Z M21.0969582,26.72424 L21.0969582,32.7895813 C21.0969582,34.8796201 21.7532521,36.310729 23.5412032,36.310729 C24.8765876,36.310729 25.8045177,35.3792482 26.1666672,34.4706491 C26.2797848,34.1980983 26.3476939,33.8345041 26.3476939,33.4483181 L26.3476939,33.4483181 L26.3476939,26.72424 L28.3393722,26.72424 L28.3393722,34.697823 C28.3393722,35.8563811 28.3619765,36.8559271 28.4298855,37.7191494 L28.4298855,37.7191494 L26.6645387,37.7191494 L26.5514211,35.9245429 L26.5061163,35.9245429 C26.0082448,36.8105502 24.8312828,37.9691083 22.8849093,37.9691083 C21.1648673,37.9691083 19.1052799,36.9922508 19.1052799,33.1530789 L19.1052799,33.1530789 L19.1052799,26.72424 L21.0969582,26.72424 Z M32.5037554,21.5902539 L32.5037554,28.4734406 L32.5490601,28.4734406 C33.2506588,27.2467207 34.5180379,26.4743486 36.2833848,26.4743486 C38.9992659,26.4743486 40.9004309,28.746088 40.9004309,32.0626536 C40.9004309,36.0154608 38.4108811,37.9690794 35.96654,37.9690794 C34.3822198,37.9690794 33.1375412,37.3557194 32.3001244,35.9018255 L32.3001244,35.9018255 L32.2548196,35.9018255 L32.1416058,37.7191205 L30.42166,37.7191205 C30.4894728,36.9695334 30.5120771,35.8563521 30.5120771,34.8795911 L30.5120771,34.8795911 L30.5120771,21.5902539 L32.5037554,21.5902539 Z M46.6265396,26.4743679 C50.2024418,26.4743679 51.1303719,29.6319215 51.1303719,31.6537985 C51.1303719,32.0626729 51.1077676,32.3580087 51.0624628,32.5851826 L51.0624628,32.5851826 L43.3900864,32.5851826 C43.435295,35.2657964 45.132829,36.3788811 47.124411,36.3788811 C48.5503088,36.3788811 49.4329341,36.1290188 50.1572332,35.810898 L50.1572332,35.810898 L50.5193828,37.2422 C49.8176879,37.5602242 48.5956135,37.9464103 46.852871,37.9464103 C43.5032041,37.9464103 41.4663172,35.6974559 41.4663172,32.4033856 C41.4663172,29.0868199 43.435295,26.4743679 46.6265396,26.4743679 Z M35.6270909,28.0417812 C34.2691984,28.0417812 33.001723,28.9959503 32.6169692,30.4952211 C32.5490601,30.7450834 32.5037554,31.0177308 32.5037554,31.335755 L32.5037554,31.335755 L32.5037554,33.3121585 C32.5037554,33.5620209 32.5263597,33.8118833 32.5716644,34.0390572 C32.9564183,35.4247892 34.1332841,36.3788618 35.5591818,36.3788618 C37.6639777,36.3788618 38.8862445,34.6751056 38.8862445,32.1536004 C38.8862445,29.9273345 37.7545873,28.0417812 35.6270909,28.0417812 Z M12.3871809,26.7001752 C10.7147611,24.2316844 7.35491062,23.5870142 4.89671928,25.2643825 C2.43738306,26.9455814 1.79510361,30.3179384 3.46752348,32.7864291 C5.13994335,35.2549199 8.49864889,35.8983133 10.9579851,34.2210726 C13.4197383,32.5410229 14.0607457,29.1675168 12.3871809,26.7001752 Z M46.4681172,27.9055734 C44.4311341,27.9055734 43.5711131,29.7682452 43.4126907,31.1539772 L43.4126907,31.1539772 L49.2066026,31.1539772 C49.2293031,29.8818804 48.6860307,27.9055734 46.4681172,27.9055734 Z M16.8137872,4.44113939e-05 C20.6918991,4.44113939e-05 23.2946002,2.69070871 23.2946002,6.55727569 C23.2946002,11.2073707 19.989151,13.3495543 16.6054959,13.3495543 L16.6054959,13.3495543 L16.579501,13.3495543 C12.8575798,13.3495543 9.99459764,10.8938262 9.99459764,6.76623129 C9.99459764,2.63863635 12.701389,4.44113939e-05 16.8137872,4.44113939e-05 Z M43.4138475,1.11028485e-05 C47.656331,1.11028485e-05 48.9837317,2.50792251 48.9837317,5.51224228 L48.9837317,5.51224228 L48.9837317,9.97947336 C48.9837317,11.1811346 49.0358322,12.3568153 49.192023,13.0621792 L49.192023,13.0621792 L45.6261821,13.0621792 L45.3920065,11.7821318 L45.3139111,11.7821318 C44.4809671,12.8009292 43.1796719,13.349632 41.6699748,13.349632 C39.0932687,13.349632 37.5576872,11.4685874 37.5576872,9.43088162 C37.5576872,6.11312844 40.5248704,4.54562829 45.0275244,4.54562829 L45.0275244,4.54562829 L45.0275244,4.3889671 C45.0275244,3.7095838 44.6631529,2.74296982 42.7110994,2.74296982 C41.4098042,2.74296982 40.030303,3.18708375 39.1974696,3.68349211 L39.1974696,3.68349211 L38.468616,1.149489 C39.3535498,0.653080649 41.0974226,1.11028485e-05 43.4138475,1.11028485e-05 Z M5.49178879,1.11028485e-05 C6.97538037,1.11028485e-05 8.2767862,0.365738931 9.05751907,0.757669482 L9.05751907,0.757669482 L8.38087654,3.4745365 C7.80821373,3.18708375 6.68910427,2.76917254 5.62198468,2.76917254 C4.65895543,2.76917254 4.11239817,3.16099206 4.11239817,3.78808094 C4.11239817,4.3889671 4.60685495,4.72849221 6.16854194,5.25099226 C8.58905722,6.08703674 9.57808141,7.31478973 9.60418695,9.16963159 C9.60418695,11.5730652 7.75622386,13.3234293 4.11239817,13.3234293 C2.44662083,13.3234293 0.96302925,12.9314987 0,12.4091097 L0,12.4091097 L0.702748085,9.58765384 C1.4314911,10.0317678 2.94107761,10.5281761 4.11239817,10.5281761 C5.30960303,10.5281761 5.80417043,10.1362456 5.80417043,9.483065 C5.80417043,8.83010649 5.41369338,8.49035932 3.95620734,8.02015369 C1.30140583,7.13203684 0.286276097,5.69510619 0.312381645,4.20599216 C0.312381645,1.80255855 2.34253049,1.11028485e-05 5.49178879,1.11028485e-05 Z M31.9617528,2.22044605e-15 C34.5644538,2.22044605e-15 36.5166179,1.75036406 36.5166179,5.51223118 L36.5166179,5.51223118 L36.5166179,13.0621681 L32.5604105,13.0621681 L32.5604105,5.98243681 C32.5604105,4.33666158 31.9877477,3.21327537 30.5562566,3.21327537 C29.4631421,3.21327537 28.8123839,3.97093375 28.5261078,4.70238941 C28.4220174,4.96363943 28.3960225,5.32947829 28.3960225,5.69509509 L28.3960225,5.69509509 L28.3960225,13.0621681 L24.4398152,13.0621681 L24.4398152,4.36275328 C24.4398152,2.76916144 24.3877147,1.43681962 24.3357248,0.287341718 L24.3357248,0.287341718 L27.7713698,0.287341718 L27.9535556,2.06379747 L28.031651,2.06379747 C28.5521027,1.22786401 29.8275136,2.22044605e-15 31.9617528,2.22044605e-15 Z M57.8070641,2.22044605e-15 C58.1714356,2.22044605e-15 58.3536214,0.0260916939 58.6398975,0.0783861102 L58.6398975,0.0783861102 L58.6398975,3.81416153 C58.3276265,3.76186712 58.0152448,3.70968373 57.5727779,3.70968373 C56.1152919,3.70968373 55.1262677,4.46723108 54.8659865,5.72129781 C54.813886,5.98243681 54.7878911,6.26977853 54.7878911,6.60952569 L54.7878911,6.60952569 L54.7878911,13.0621681 L50.8316838,13.0621681 L50.8313294,4.12570822 C50.8279862,2.44935153 50.8004825,1.31137964 50.7275934,0.287341718 L50.7275934,0.287341718 L54.1111379,0.287341718 L54.2673288,2.66479466 L54.3714191,2.66479466 C55.0220667,0.783750073 56.5577588,2.22044605e-15 57.8070641,2.22044605e-15 Z M45.1577203,7.02744801 C43.0754709,7.02744801 41.4617941,7.52385636 41.4617941,9.03895107 C41.4617941,10.0578595 42.1385472,10.5542678 43.0234811,10.5542678 C43.9865103,10.5542678 44.8193437,9.90108725 45.0796249,9.09124548 C45.1317253,8.88228987 45.1577203,8.64713154 45.1577203,8.41208424 L45.1577203,8.41208424 Z M16.6835913,2.84759196 C14.8096333,2.84759196 14.0808903,4.78081993 14.0808903,6.68773416 C14.0808903,8.85623149 14.991819,10.5020067 16.6575964,10.5020067 L16.6575964,10.5020067 L16.6835913,10.5020067 C18.2452783,10.5020067 19.2083075,8.96059826 19.2083075,6.66175349 C19.2083075,4.78081993 18.4795645,2.84759196 16.6835913,2.84759196 Z" id="形状结合"></path>
                </g>
                <g id="Group-19" transform="translate(38.543232, 16.390996)">
                    <path d="M20.5843052,22.6126885 L19.2826977,22.6126885 C19.2826977,12.0896561 10.6321482,3.52896569 0,3.52896569 L0,2.22251314 C11.3508162,2.22251314 20.5843052,11.3674102 20.5843052,22.6126885" id="Fill-4" fill="#499CD2"></path>
                    <path d="M21.4837645,15.5938036 C19.9221233,8.99265662 14.5923774,3.48291349 7.90993475,1.55695451 C8.20972452,0.509878521 C15.2625645,2.54291045 20.8876929,8.36339988 22.5384704,15.3415592 L21.4837645,15.5938036 Z" id="Fill-6" fill="#489CD2"></path>
                    <path d="M22.9494244,9.39894702 C21.3392124,5.87447731 18.5931633,2.80050848 15.2236989,0.744364681 L15.674328,0 C19.1928328,2.14732734 22.0543725,5.35400886 23.736901,9.03520593 L22.9494244,9.39894702 Z" id="Fill-8" fill="#489CD2"></path>
                </g>
            </g>
        </g>
    </g>
</svg>
tekton.dev/pipelines.minVersion: 0.56.0
tekton.dev/platforms: linux/amd64,linux/arm64
tekton.dev/tags: sonarqube, connector, kubernetes, secret, user-token
labels:
app.kubernetes.io/version: "0.1"
name: sonarqube-connector-automatic-creation
namespace: ${TARGET_NS}
spec:
description: Automatically provisions and maintains a tenant-scoped SonarQube Connector in one TaskRun. For the given tenant, the Task creates or reuses a dedicated SonarQube user, a permission template scoped to the tenant's project key pattern, and a user token; then creates or updates the tenant SonarQube Connector together with its token Secret. SonarQube projects are not created upfront -- they are auto-created at scan time by the tenant user. The user token is refreshed on every run and auto-renewed before expiry, so the Task is safe to schedule on a recurring basis.
params:
- description: Target tenant SonarQube Connector to create or update, in <namespace>/<name> format, for example connectors-management/acme-sonarqube. The token Secret is created in the same namespace as the Connector
name: connector
type: string
- description: Tenant identifier. Used to derive default names for the SonarQube user and permission template when those fields are left empty
name: tenant
type: string
- default: ""
description: Optional SonarQube server URL, for example https://sonarqube.example.com. Set this to override the address provided by the sonarqube-config workspace; leave empty to use the workspace value
name: sonarqubeUrl
type: string
- description: Regular expression matching the tenant project key space. Used to scope the permission template so it only applies to this tenant. Must not overlap with the patterns used by other tenants
name: projectPattern
type: string
- default: ""
description: Name of the SonarQube permission template to create or reuse. Leave empty to use <tenant>-template
name: permissionTemplate
type: string
- default:
- user
- codeviewer
- scan
description: Project-level permissions granted to the tenant user. The default covers Browse, See Source Code, and Execute Analysis. Do not include 'admin', otherwise the tenant could change project visibility or delete projects
name: templatePermissions
type: array
- default: ""
description: SonarQube user login to create or reuse. Leave empty to use <tenant>-bot
name: userName
type: string
- default: "30"
description: Validity of the SonarQube user token, in whole days (positive integer). The token is automatically renewed before it expires on each run, so the Task can be scheduled on a recurring basis
name: tokenDuration
type: string
- default: ${REGISTRY}/devops/sonarqube-connector-automatic-creation:v1.9.0-g8632398
description: Tool image used by every step. The default points at the release image published by this repository; override for air-gapped clusters or to pin a specific version
name: sonarqubeAutomationImage
type: string
- default: Always
description: Controls when Kubernetes pulls the tool image
name: imagePullPolicy
type: string
- default: "false"
description: Enable verbose logging for debugging. Credentials and tokens are never logged regardless of this flag
name: verbose
type: string
results:
- description: Tenant identifier handled by this run
name: tenant
- description: SonarQube user login created or reused by this run
name: username
- description: SonarQube permission template name created or reused by this run
name: permission-template
- description: Name of the SonarQube user token created or reused by this run. NEVER exposes the token value as a result; the value is written only to the tenant Secret
name: token-name
- description: Reference of the tenant Connector created or updated by this run, in <namespace>/<name> format
name: connector-ref
stepTemplate:
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
runAsGroup: 65532
runAsNonRoot: true
runAsUser: 65532
seccompProfile:
type: RuntimeDefault
volumeMounts:
- mountPath: /workspace/state
name: state
- mountPath: /workspace/secrets
name: secrets
steps:
- args:
- $(params.templatePermissions[*])
computeResources:
limits:
cpu: 500m
memory: 256Mi
requests:
cpu: 100m
memory: 128Mi
env:
- name: TENANT
value: $(params.tenant)
- name: CONNECTOR_REF
value: $(params.connector)
- name: SONARQUBE_URL
value: $(params.sonarqubeUrl)
- name: PROJECT_PATTERN
value: $(params.projectPattern)
- name: PERMISSION_TEMPLATE
value: $(params.permissionTemplate)
- name: USER_NAME
value: $(params.userName)
- name: TOKEN_DURATION_DAYS
value: $(params.tokenDuration)
- name: VERBOSE
value: $(params.verbose)
- name: SONAR_CONFIG_DIR
value: $(workspaces.sonarqube-config.path)
- name: STATE_DIR
value: /workspace/state
- name: SECRETS_DIR
value: /workspace/secrets
image: $(params.sonarqubeAutomationImage)
imagePullPolicy: $(params.imagePullPolicy)
name: ensure-tenant
script: |
#!/usr/bin/env bash
ensure-tenant.sh "$@"
- computeResources:
limits:
cpu: 500m
memory: 256Mi
requests:
cpu: 100m
memory: 128Mi
env:
- name: TENANT
value: $(params.tenant)
- name: CONNECTOR_REF
value: $(params.connector)
- name: SONARQUBE_URL
value: $(params.sonarqubeUrl)
- name: VERBOSE
value: $(params.verbose)
- name: SONAR_CONFIG_DIR
value: $(workspaces.sonarqube-config.path)
- name: STATE_DIR
value: /workspace/state
- name: SECRETS_DIR
value: /workspace/secrets
- name: WORKSPACE_KUBECONFIG_BOUND
value: $(workspaces.kubeconfig.bound)
- name: WORKSPACE_KUBECONFIG_PATH
value: $(workspaces.kubeconfig.path)
image: $(params.sonarqubeAutomationImage)
imagePullPolicy: $(params.imagePullPolicy)
name: apply-kubernetes-resources
script: |
#!/usr/bin/env bash
apply-step.sh
- computeResources:
limits:
cpu: 100m
memory: 128Mi
requests:
cpu: 50m
memory: 64Mi
env:
- name: TENANT
value: $(params.tenant)
- name: CONNECTOR_REF
value: $(params.connector)
- name: PERMISSION_TEMPLATE
value: $(params.permissionTemplate)
- name: USER_NAME
value: $(params.userName)
- name: VERBOSE
value: $(params.verbose)
- name: RESULT_TENANT_PATH
value: $(results.tenant.path)
- name: RESULT_USERNAME_PATH
value: $(results.username.path)
- name: RESULT_PERMISSION_TEMPLATE_PATH
value: $(results.permission-template.path)
- name: RESULT_TOKEN_NAME_PATH
value: $(results.token-name.path)
- name: RESULT_CONNECTOR_REF_PATH
value: $(results.connector-ref.path)
image: $(params.sonarqubeAutomationImage)
imagePullPolicy: $(params.imagePullPolicy)
name: write-results
script: |
#!/usr/bin/env bash
write-results.sh
volumes:
- emptyDir:
medium: Memory
name: state
- emptyDir:
medium: Memory
name: secrets
workspaces:
- description: |
SonarQube admin access for the Task. Bind this workspace to a
SonarQube ConnectorClass configuration (recommended), or to a
Secret that provides the SonarQube address plus either an admin
token or a username/password pair. Credentials are read from
the workspace and never appear in the Pod spec, environment
variables, or process arguments.
name: sonarqube-config
- description: |
Optional. Bind this workspace to a kubeconfig when the tenant
Connector and its Secret need to be applied to a different
cluster than the one running the Task. Leave unbound to apply
to the current cluster.
name: kubeconfig
optional: true
EOF
说明:
- 默认的
sonarqubeAutomationImage 位于
${REGISTRY}/devops/sonarqube-connector-automatic-creation:v1.9.0-g8632398。如果是 air-gapped 集群,或需要锁定特定版本,请在 TaskRun 时覆盖 sonarqubeAutomationImage 参数。
- Task Pod 以非 root 用户运行(
runAsUser: 65532),启用 RuntimeDefault seccomp,不包含任何 capabilities,并使用 tmpfs 支撑的 state / secrets 卷。
描述
给定一个租户标识和一个项目 key 模式,该 Task 会:
- 创建(或复用)一个专用的 本地 SonarQube 用户
<tenant>-bot。
- 授予该用户全局
provisioning 权限,使租户可以在扫描时自动创建匹配其模式的项目。
- 创建(或复用)一个与租户
projectKeyPattern 绑定范围一致的 权限模板,并将项目级权限
(默认 user、codeviewer、scan)直接绑定到租户用户,而不是通过任何 group。
- 生成(或复用)一个
USER_TOKEN,并使用可配置的有效期
(tokenDuration 天;默认 30 天)。
- 写入一个带有
tokenAuth 的租户 sonarqube Connector,以及一个匹配的 Secret(connectors.cpaas.io/bearer-token),其中包含新生成的令牌。
步骤 1–3 只写入一次;步骤 4 会在令牌仍然有效且租户 Secret 仍持有非空令牌值时复用。
该 Task 不会预先创建任何 SonarQube 项目。项目会在扫描时由租户用户自动创建——限制此自动创建仅作用于该租户命名空间的,是租户模板上的 projectKeyPattern。
为什么需要专用用户(而不是 group)
SonarQube 权限模板可以绑定到用户或 group。本 Task 采用 直接绑定到用户 的方式。原因是为了兼容外部 provisioning:当 SonarQube 实例启用了 SCIM / GitHub / GitLab provisioning 时,非 IDP 用户的 group membership 会在每次同步时被清空,这会静默撤销租户的项目权限。将权限直接绑定到本地租户用户,可以绕过 group 间接层。请参阅
使用该 Task — 必须允许创建本地用户。
参数
Workspaces
Workspace 绑定模式
sonarqube-config workspace 会自动检测。请选择最符合你集群中 admin Connector 暴露方式的绑定模式:
模式 A — Secret 直连(bootstrap / 跨集群)。
将 sonarqube-config 绑定到一个 Secret,该 Secret 的 data 仅包含凭证——以下之一:
token — 一个 SonarQube admin token(推荐),或
username + password — admin Basic-auth 凭证
在 TaskRun 运行时通过 sonarqubeUrl 参数传入 SonarQube 基础 URL。Task 会在运行时读取 workspace 文件,并采用 curl 的 --config 形式,因此 admin 凭证不会出现在 Pod 环境变量或 argv 中。同一个 Secret 可以通过变化 sonarqubeUrl 参数来目标指向多个 SonarQube 实例。
模式 B — Connectors CSI Driver(推荐用于 day-2 路径)。
将 sonarqube-config 绑定到由
Connectors CSI Driver
从 SonarQube sonar-scanner ConnectorClass 配置投影出来的 volume。Task 会从投影的 sonar-project.properties 中读取 sonar.host.url 以及 sonar.scanner.proxy* 路由字段,并通过
Connectors Proxy
转发每一次 API 调用,由其从 admin Connector 注入 SonarQube Authorization header。admin token 永远不会进入 Task Pod。
结果
步骤
该 Task 按顺序执行三个步骤:
第一步对 state 和 secrets 都使用 tmpfs 卷(emptyDir.medium: Memory),因此凭证不会接触节点文件系统。
失败处理
失败按步骤范围处理:
ensure-tenant 失败。 其 trap 处理器只会吊销本次运行生成的令牌,并且只删除本次运行创建的模板 / provisioning 授权 / 用户——从之前运行复用的内容都会保留。TaskRun 以非零状态退出。
apply-kubernetes-resources 失败(例如 SSA 被拒绝、kubeconfig 无效、RBAC 缺失)。SonarQube 侧不会回滚——用户、模板和令牌都会保留。TaskRun 以非零状态退出;下一次运行会自动修复:它会在 user_tokens/search 中命中,但发现 tenant Secret 缺失或为空,然后重新生成并重新应用。
write-results 失败。 SonarQube 状态以及集群中的 Secret / Connector 都已经正确;只是缺少 Task 结果。重新运行时,对于这些有副作用的状态不会产生影响。
三条生命周期路径总结
该 Task 将三种生命周期路径收敛为同一种 TaskRun 形态:
注意:该 Task 不会检查令牌的 expirationDate——SonarQube 没有 token renew API,Task 也不会轮询过期状态。如果 user_tokens/search 中的令牌已过期但仍然存在,Task 会将其视为已复用;过期会在扫描时以 401 暴露,且下一次 Task 运行(搜索命中但 Secret 仍保留失效值)只有在 operator 先清空 tenant Secret 后才会自愈。若要实现纯粹按节奏驱动的轮换,请通过 cron 调度 TaskRun,并配合一次显式吊销(参阅
使用该 Task — Rotation)。
这三条路径都由相同的参数驱动,并以相同的结果退出,因此同一个 TaskRun 可以通过 cron 调度执行,而调用方无需进行条件分支。
安全说明
- admin token 永远不会离开 workspace。 Task 仅通过
sonarqube-config workspace 读取 admin 凭证(curl --config 形式,或在模式 B 中通过 Connectors Proxy)。admin token 不会出现在任何环境变量、命令参数或 Pod spec 中。
- 租户 token 存储在 tmpfs 中。 新生成的令牌会写入
medium: Memory 卷上的 /workspace/secrets/token,在步骤退出时由 trap 清除,并且不会被记录。
- Pod 以非 root 身份运行。
runAsUser: 65532、runAsNonRoot: true、allowPrivilegeEscalation: false、全部 capabilities 已丢弃、seccompProfile: RuntimeDefault。
- verbose 模式可安全开启。
verbose=true 会为 helper 脚本启用 shell tracing,但无论该标志如何,凭证和令牌都会被脱敏。
- 限制谁可以触发 TaskRun。 触发此 Task 会生成(并轮换)SonarQube 令牌,并向目标命名空间写入 Secret——请通过 Tekton RBAC 对
TaskRun.create 以及 workspace 访问进行控制。
另请参阅