Ajouter des règles d'administration personnalisées

Cette page explique comment créer, configurer et gérer des contraintes personnalisées dans des instances Cloud SQL. Pour obtenir une présentation des règles d'administration personnalisées, consultez la page Règles d'administration personnalisées.

Ressources compatibles avec Cloud SQL

Cette page vous explique comment utiliser les contraintes personnalisées du service de règles d'administration pour restreindre des opérations spécifiques sur les ressources Google Cloud suivantes :

  • sqladmin.googleapis.com/Instance
  • sqladmin.googleapis.com/BackupRun

Pour en savoir plus sur les règles d'administration, consultez Règles d'administration personnalisées.

À propos des règles et des contraintes de l'organisation

Le service de règles d'administration Google Cloud vous offre un contrôle centralisé et automatisé sur les ressources de votre organisation. En tant qu'administrateur des règles d'administration, vous pouvez définir une règle d'administration, c'est-à-dire un ensemble de restrictions appelées Contraintes qui s'appliquent aux ressourcesGoogle Cloud et aux descendants de ces ressources dans la Hiérarchie des ressourcesGoogle Cloud . Vous pouvez appliquer des règles d'administration au niveau d'une organisation, d'un dossier ou d'un projet.

Les règles d'administration fournissent des contraintes gérées intégrées pour divers services Google Cloud . Toutefois, si vous souhaitez exercer un contrôle plus précis et personnalisable sur les champs spécifiques restreints dans vos règles d'administration d'administration, vous pouvez également créer des contraintes personnalisées et les utiliser dans une règle d'administration.

Héritage des règles

Par défaut, les règles d'administration sont héritées par les descendants des ressources sur lesquelles vous les appliquez. Par exemple, si vous appliquez une stratégie à un dossier, Google Cloud l'applique à tous les projets du dossier. Pour mieux comprendre ce comportement et savoir comment le modifier, consultez la page Règles d'évaluation hiérarchique.

Avant de commencer

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Install the gcloud CLI.

  5. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  6. To initialize the gcloud CLI, run the following command: 

    gcloud init

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

  9. Install the gcloud CLI.

  10. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  11. To initialize the gcloud CLI, run the following command: 

    gcloud init
  12. Assurez-vous de connaître votre ID d'organisation.

    13. Rôles requis

    Pour obtenir les autorisations nécessaires pour gérer des règles d'administration personnalisées, demandez à votre administrateur de vous accorder le rôle IAM Administrateur des règles d'administration (roles/orgpolicy.policyAdmin) dans la ressource d'organisation. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

    Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

    Créer une contrainte personnalisée

    Une contrainte personnalisée est définie dans un fichier YAML, qui spécifie les ressources, méthodes, conditions et actions compatibles avec le service sur lequel vous appliquez la règle d'administration. Les conditions de vos contraintes personnalisées sont définies à l'aide du langage CEL (Common Expression Language). Pour en savoir plus sur la création de conditions dans des contraintes personnalisées à l'aide du CEL, consultez la section CEL de la page Créer et gérer des contraintes personnalisées.

    Pour créer une contrainte personnalisée, créez un fichier YAML au format suivant :

    name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

    Remplacez les éléments suivants :

    • ORGANIZATION_ID : ID de votre organisation (par exemple, 123456789).

    • CONSTRAINT_NAME : nom souhaité pour votre nouvelle contrainte personnalisée. Une contrainte personnalisée doit commencer par custom. et ne peut inclure que des lettres majuscules, minuscules ou des chiffres. Exemple : custom.region. La longueur maximale de ce champ est de 70 caractères.

    • RESOURCE_NAME : nom complet de la ressourceGoogle Cloud contenant l'objet et le champ que vous souhaitez restreindre. Par exemple, sqladmin.googleapis.com/Instance.

    • CONDITION : condition CEL écrite pour une représentation d'une ressource de service acceptée. Ce champ ne doit pas comporter plus de 1 000 caractères. Consultez la section Ressources compatibles pour en savoir plus sur les ressources disponibles pour l'écriture de conditions. Par exemple, "resource.region == "us-central1"".

    • ACTION : action à effectuer si la condition est remplie. Les valeurs possibles sont ALLOW et DENY.

    • DISPLAY_NAME : nom convivial de la contrainte. Ce champ ne doit pas comporter plus de 200 caractères.

    • DESCRIPTION : description conviviale de la contrainte, qui sera affichée dans un message d'erreur en cas de non-respect de la règle. Ce champ ne doit pas comporter plus de 2 000 caractères.

    Pour en savoir plus sur la création d'une contrainte personnalisée, consultez la page Définir des contraintes personnalisées.

    Configurer une contrainte personnalisée

    Après avoir créé le fichier YAML pour une nouvelle contrainte personnalisée, vous devez le configurer de sorte qu'il soit disponible pour les règles d'administration de votre organisation. Pour configurer une contrainte personnalisée, utilisez la commande gcloud org-policies set-custom-constraint : 
    gcloud org-policies set-custom-constraint CONSTRAINT_PATH
     Remplacez CONSTRAINT_PATH par le chemin d'accès complet à votre fichier de contrainte personnalisée. Par exemple, /home/user/customconstraint.yaml. Une fois l'opération terminée, vos contraintes personnalisées sont disponibles en tant que règles d'administration dans votre liste de règles d'administration Google Cloud . Pour vérifier que la contrainte personnalisée existe, utilisez la commande gcloud org-policies list-custom-constraints : 
    gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
     Remplacez ORGANIZATION_ID par l'ID de votre ressource d'organisation. Pour en savoir plus, consultez la page Afficher les règles d'administration.

    Appliquer une règle d'administration personnalisée

    Vous pouvez appliquer une contrainte en créant une règle d'administration qui la référence, puis en appliquant cette règle d'administration à une ressource Google Cloud .

    Console

    1. Dans la console Google Cloud , accédez à la page Règles d'administration.

      Accéder à la page Règles d'administration

    2. Dans le sélecteur de projets, choisissez le projet pour lequel vous souhaitez définir la règle d'administration.
    3. Dans la liste de la page Règles d'administration, sélectionnez votre contrainte pour afficher la page Détails de la règle associée.
    4. Pour configurer la règle d'administration pour cette ressource, cliquez sur Gérer la règle.
    5. Sur la page Modifier la stratégie, sélectionnez Remplacer la stratégie parente.
    6. Cliquez sur Ajouter une règle.
    7. Dans la section Application, indiquez si l'application de cette règle d'administration est activée ou désactivée.
    8. Facultatif : Pour rendre la règle d'administration conditionnelle sur un tag, cliquez sur Ajouter une condition. Notez que si vous ajoutez une règle conditionnelle à une règle d'administration, vous devez ajouter au moins une règle inconditionnelle, sinon la règle ne pourra pas être enregistrée. Pour en savoir plus, consultez la section Définir une règle d'administration avec des tags.
    9. Cliquez sur Tester les modifications pour simuler l'effet de la règle d'administration. La simulation de règles n'est pas disponible pour les anciennes contraintes gérées. Pour en savoir plus, consultez Tester les modifications apportées aux règles d'administration à l'aide de Policy Simulator.
    10. Pour finaliser et appliquer la règle d'administration, cliquez sur Définir la règle. La prise en compte de la règle peut prendre jusqu'à 15 minutes.

    gcloud

    Pour créer une règle d'administration avec des règles booléennes, créez un fichier YAML de règle qui référence la contrainte : 

          name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true

    Remplacez les éléments suivants :

    • PROJECT_ID : projet sur lequel vous souhaitez appliquer votre contrainte.
    • CONSTRAINT_NAME : nom que vous avez défini pour la contrainte personnalisée. Exemple : custom.region.

    Pour appliquer la règle d'administration contenant la contrainte, exécutez la commande suivante : 

        gcloud org-policies set-policy POLICY_PATH

    Remplacez POLICY_PATH par le chemin d'accès complet au fichier YAML de votre règle d'administration. La prise en compte de la règle peut prendre jusqu'à 15 minutes.

    Exemples de règles d'administration personnalisées pour des cas d'utilisation courants

    Le tableau suivant fournit la syntaxe de certaines contraintes personnalisées pour les cas d'utilisation courants :

    Description Syntaxe de la contrainte
    S'assurer que les instances sont Enterprise Plus 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.edition
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.edition == 'ENTERPRISE_PLUS'"
    actionType: ALLOW
    displayName: Instances must be Enterprise Plus.
    description: Cloud SQL instances must be Enterprise Plus.
    Assurer la disponibilité élevée des instances 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.availability
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.availabilityType == 'REGIONAL'"
    actionType: ALLOW
    displayName: Instances must be regional.
    description: Cloud SQL instances must be highly available. To do this, make them regional.
    Assurez-vous que les instances disposent d'une règle de mot de passe. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enforcePassword
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.passwordValidationPolicy.enablePasswordPolicy == true"
    actionType: ALLOW
    displayName: The password policy must be enabled for Cloud SQL instances.
    description: Cloud SQL instances must have a password policy.
    Assurez-vous que la stratégie de mot de passe pour les instances a une longueur minimale 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.passwordMinLength
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.passwordValidationPolicy.minLength >= 6"
    actionType: ALLOW
    displayName: The password policy must have a minimum length of six characters.
    description: Cloud SQL instances must have a password policy that has a minimum length of six characters.
    Assurez-vous que la complexité des règles de mot de passe est activée sur les instances. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.passwordComplexity
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.passwordValidationPolicy.complexity == 'COMPLEXITY_DEFAULT'"
    actionType: ALLOW
    displayName: The password policy complexity must be enabled.
    description: Cloud SQL instances must have a password policy with complex passwords.
    Exigez que le mode SSL soit activé avec des connexions chiffrées uniquement. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.sslMode
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.ipConfiguration.sslMode == 'ENCRYPTED_ONLY'"
    actionType: ALLOW
    displayName: Only allow connections that are encrypted with SSL/TLS.
    description: Cloud SQL instances must only allow connections that are encrypted with SSL/TLS.
    Bloquez l'accès à la base de données depuis n'importe quel point de l'Internet public. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.authorizedNetworks
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.ipConfiguration.authorizedNetworks.exists(network, network.value == '0.0.0.0/0')"
    actionType: DENY
    displayName: The list of authorized networks can't contain 0.0.0.0/0
    description: Authorized networks for Cloud SQL instances can't contain 0.0.0.0/0. This allows users to access the database from any IP address.
    Assurez-vous que les instances ne sont pas créées avec une adresse IP externe. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.ipv4Enabled
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.ipConfiguration.ipv4Enabled == false"
    actionType: ALLOW
    displayName: ipv4Enabled must be set to false.
    description: Cloud SQL instances can't have an external IP address.
    Assurez-vous que les instances sont chiffrées avec une clé KMS. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.encrypted
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.diskEncryptionConfiguration.kmsKeyName.size() > 0"
    actionType: ALLOW
    displayName: Instances must be encrypted with a KMS key.
    description: Cloud SQL instances must be disk-encrypted with a KMS key.
    S'assurer que les instances se trouvent dans us-central1 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.region
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.region == 'us-central1'"
    actionType: ALLOW
    displayName: Instances must be in the us-central1 region.
    description: Cloud SQL instances must be in the us-central1 region.
    Assurez-vous que le cache de données est activé pour les instances. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.dataCache
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.dataCacheConfig.dataCacheEnabled == true"
    actionType: ALLOW
    displayName: Instances must have data cache enabled.
    description: Cloud SQL instances must have data cache enabled.
    Appliquez les sauvegardes automatiques. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enableBackups
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.backupConfiguration.enabled == true"
    actionType: ALLOW
    displayName: Automated backups must be enabled.
    description: Cloud SQL instances must have automated backups enabled.
    Restreindre l'emplacement des sauvegardes automatiques 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.automatedBackupLocation
    resourceTypes:
    - sqladmin.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.settings.backupConfiguration.location == 'us-central1'"
    actionType: ALLOW
    displayName: The location of automated backups must be in the us-central1 region.
    description: The location of automated backups for Cloud SQL instances must be in the us-central1 region.
    Restreindre l'emplacement des sauvegardes à la demande à us-central1 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.onDemandBackupLocation
    resourceTypes:
    - sqladmin.googleapis.com/BackupRun
    methodTypes:
    - CREATE
    - UPDATE
    condition: "condition: resource.location == 'us-central1'"
    actionType: ALLOW
    displayName: The location of on-demand backups must be in the us-central1 region.
    description: On-demand backups are restricted to the us-central1.

    Ressources compatibles avec Cloud SQL pour PostgreSQL

    Le tableau suivant liste les ressources Cloud SQL pour PostgreSQL que vous pouvez référencer dans des contraintes personnalisées.

    Ressource Champ
    sqladmin.googleapis.com/BackupRun resource.description
    resource.location
    sqladmin.googleapis.com/Instance resource.databaseVersion
    resource.diskEncryptionConfiguration.kmsKeyName
    resource.diskEncryptionStatus.kmsKeyVersionName
    resource.failoverReplica.name
    resource.masterInstanceName
    resource.name
    resource.nodeCount
    resource.project
    resource.region
    resource.replicaConfiguration.cascadableReplica
    resource.replicaConfiguration.failoverTarget
    resource.settings.activationPolicy
    resource.settings.activeDirectoryConfig.domain
    resource.settings.advancedMachineFeatures.threadsPerCore
    resource.settings.availabilityType
    resource.settings.backupConfiguration.backupRetentionSettings.retainedBackups
    resource.settings.backupConfiguration.backupRetentionSettings.retentionUnit
    resource.settings.backupConfiguration.binaryLogEnabled
    resource.settings.backupConfiguration.enabled
    resource.settings.backupConfiguration.location
    resource.settings.backupConfiguration.pointInTimeRecoveryEnabled
    resource.settings.backupConfiguration.startTime
    resource.settings.backupConfiguration.transactionLogRetentionDays
    resource.settings.collation
    resource.settings.connectionPoolConfig.connectionPoolingEnabled
    resource.settings.connectionPoolConfig.flags.name
    resource.settings.connectionPoolConfig.flags.value
    resource.settings.connectorEnforcement
    resource.settings.databaseFlags.name
    resource.settings.databaseFlags.value
    resource.settings.dataCacheConfig.dataCacheEnabled
    resource.settings.dataDiskProvisionedIops
    resource.settings.dataDiskProvisionedThroughput
    resource.settings.dataDiskSizeGb
    resource.settings.dataDiskType
    resource.settings.deletionProtectionEnabled
    resource.settings.denyMaintenancePeriods.endDate
    resource.settings.denyMaintenancePeriods.startDate
    resource.settings.denyMaintenancePeriods.time
    resource.settings.edition
    resource.settings.enableDataplexIntegration
    resource.settings.enableGoogleMlIntegration
    resource.settings.insightsConfig.queryInsightsEnabled
    resource.settings.insightsConfig.queryPlansPerMinute
    resource.settings.insightsConfig.queryStringLength
    resource.settings.insightsConfig.recordApplicationTags
    resource.settings.insightsConfig.recordClientAddress
    resource.settings.ipConfiguration.authorizedNetworks.name
    resource.settings.ipConfiguration.authorizedNetworks.value
    resource.settings.ipConfiguration.customSubjectAlternativeNames
    resource.settings.ipConfiguration.enablePrivatePathForGoogleCloudServices
    resource.settings.ipConfiguration.ipv4Enabled
    resource.settings.ipConfiguration.privateNetwork
    resource.settings.ipConfiguration.pscConfig.allowedConsumerProjects
    resource.settings.ipConfiguration.pscConfig.pscAutoConnections.consumerNetwork
    resource.settings.ipConfiguration.pscConfig.pscAutoConnections.consumerProject
    resource.settings.ipConfiguration.pscConfig.pscEnabled
    resource.settings.ipConfiguration.serverCaMode
    resource.settings.ipConfiguration.serverCaPool
    resource.settings.ipConfiguration.sslMode
    resource.settings.locationPreference.secondaryZone
    resource.settings.locationPreference.zone
    resource.settings.maintenanceWindow.day
    resource.settings.maintenanceWindow.hour
    resource.settings.maintenanceWindow.updateTrack
    resource.settings.passwordValidationPolicy.complexity
    resource.settings.passwordValidationPolicy.disallowUsernameSubstring
    resource.settings.passwordValidationPolicy.enablePasswordPolicy
    resource.settings.passwordValidationPolicy.minLength
    resource.settings.passwordValidationPolicy.passwordChangeInterval
    resource.settings.passwordValidationPolicy.reuseInterval
    resource.settings.replicationLagMaxSeconds
    resource.settings.retainBackupsOnDelete
    resource.settings.sqlServerAuditConfig.bucket
    resource.settings.sqlServerAuditConfig.retentionInterval
    resource.settings.sqlServerAuditConfig.uploadInterval
    resource.settings.storageAutoResize
    resource.settings.tier
    resource.settings.timeZone

    Étapes suivantes