View a markdown version of this page

SonarQube Token - AWS Secrets Manager
Campos de valores secretosCampos de metadatos secretosFlujo de uso

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

SonarQube Token

Campos de valores secretos

Los siguientes son los campos que deben estar incluidos en el secreto de Secrets Manager:

{
  "token": "token value",
  "tokenName": "token name",
  "login": "user that owns the token",
  "sonarqubeUrl": "https://sonarqube.example.com",
  "tokenType": "USER_TOKEN",
  "projectKey": "project key"
}
token

El valor del SonarQube token (empieza squ_ porsqa_, osqp_). El proceso de rotación actualiza este campo.

Nombre del token

El nombre del token (único por usuario). Rotation usa este nombre para revocar el token anterior.

login

El SonarQube usuario propietario del token.

URL de SonarQube

La URL de tu SonarQube instancia (por ejemplo,). https://sonarqube.example.com La URL debe usar HTTPS y no debe terminar con una barra al final.

tokenType

(Opcional) El tipo de token: USER_TOKEN (predeterminado)GLOBAL_ANALYSIS_TOKEN, o. PROJECT_ANALYSIS_TOKEN

projectKey

(Opcional) La clave SonarQube del proyecto. Solo se requiere cuando tokenType esPROJECT_ANALYSIS_TOKEN.

Campos de metadatos secretos

Los siguientes son los campos de metadatos de SonarQube Token:

{
  "adminSecretArn": "arn:aws:secretsmanager:us-east-1:111122223333:secret:SonarQubeAdmin"
}
administrador SecretArn

(Opcional) El nombre de recurso de Amazon (ARN) de un tipo de secreto SonarQubeToken que contiene un token de administrador. Este campo es obligatorio para los tokens de análisis global y análisis de proyectos. Es opcional para los tokens de usuario; omítelo para permitir la rotación automática, en la que el token actual genera y revoca su propio sustituto.

Flujo de uso

Esta rotación admite un solo secreto (autorrotación) para los tokens de usuario y la rotación con dos secretos (asistida por un administrador) para los tokens de análisis global y análisis de proyectos. El tokenType valor determina el alcance del token.

Para crear tu secreto, usa la llamada a la CreateSecret API. Establezca el valor secreto en los campos descritos anteriormente y establezca el tipo de secreto en SonarQubeToken. Para configurar la rotación, utilice la llamada a la RotateSecret API. En la RotateSecret llamada, proporciona un ARN de rol que conceda al servicio permiso para rotar el secreto. Para ver un ejemplo de política de permisos, consulta Seguridad y permisos. Cuando utilices la rotación asistida por un administrador, concede explícitamente al rol de rotación acceso al ARN secreto del administrador.

Durante la rotación, el controlador genera un nuevo token, lo almacena como la versión pendiente, lo verifica con la SonarQube API, lo promueve a la versión actual y, a continuación, revoca el token anterior por su valor. tokenName Las aplicaciones que utilizan la biblioteca de almacenamiento en caché de Secrets Manager recogen el nuevo token en su próxima actualización.

SonarQubeEl servidor está hospedado por el cliente, por lo que se debe poder acceder a la SonarQube instancia a través de HTTPS desde el servicio de rotación de Secrets Manager. Las llamadas de rotación se originan en la lista de prefijos administrada por AWS-managed. com.amazonaws.region.secretsmanager-managed-external-secrets Permita el acceso entrante desde esta lista de prefijos del firewall o grupo de seguridad de la instancia y asegúrese de que la instancia presente un certificado TLS de confianza pública. Para obtener más información, consulte Listas de prefijos administradas de AWS en la Guía del usuario de Amazon VPC. No se admiten las instancias a las que no se pueda acceder a través de la Internet pública.