Ressources au niveau du projet


Config Connector peut gérer vos ressources au niveau du projet, du dossier ou de l'organisation. Pour que Config Connector détermine où créer vos ressources, il recherche d'abord un champ définissant le champ d'application dans votre spécification de ressource, s'il ne le trouve pas, puis recherche une annotation de définition du champ d'application.

Spécifier le champ projectRef

La plupart des ressources Config Connector à l'échelle du projet acceptent un champ nommé projectRef dans sa spécification CRD. Utilisez ce champ pour spécifier le projet Google Cloud dans lequel vous souhaitez créer la ressource.

Si le projet Google Cloud est également géré dans le même cluster avec la CRD Project, vous pouvez spécifier le projet en tant que référence à une ressource Kubernetes:

...
spec:
  projectRef:
    name: PROJECT_RESOURCE_NAME
    namespace: PROJECT_RESOURCE_NAMESPACE
...

Cette approche permet d'utiliser Config Connector et de créer un projet Google Cloud avec ses ressources enfants en une seule opération d'application. Le champ d'espace de noms est facultatif si la ressource Kubernetes du projet se trouve dans le même espace de noms Kubernetes que votre ressource à l'échelle du projet.

Si le projet Google Cloud n'est pas géré en tant que ressource Kubernetes dans le même cluster, vous pouvez utiliser le champ external pour spécifier directement l'ID du projet. Le format exact de la valeur peut varier en fonction du type de ressource. Les deux formats les plus courants sont "PROJECT_ID" et "projects/PROJECT_ID". Vous trouverez ci-dessous un exemple de "projects/PROJECT_ID" :

...
spec:
  projectRef:
    external: "projects/PROJECT_ID"
...

Annoter la configuration des ressources

Si la ressource Config Connector est définie au niveau du projet, mais qu'elle n'est pas compatible avec le champ projectRef, vous pouvez définir l'ID du projet sur la configuration de la ressource à l'aide de l'annotation project-id:

...
metadata:
  annotations:
    cnrm.cloud.google.com/project-id: PROJECT_ID
...

Voici un exemple de fichier YAML d'une ressource FooBar avec cette annotation:

apiVersion: foo.cnrm.cloud.google.com/v1beta1
kind: FooBar
metadata:
  annotations:
    cnrm.cloud.google.com/project-id: PROJECT_ID
  name: foobarname

Annoter la configuration de l'espace de noms

Vous pouvez annoter votre espace de noms Kubernetes pour définir un ID de projet par défaut pour les ressources nouvellement créées. Si cette annotation est explicitement définie dans l'une des ressources de l'espace de noms, l'annotation au niveau de la ressource écrase l'annotation au niveau de l'espace de noms.

Pour annoter l'espace de noms à l'aide de la ligne de commande, exécutez la commande suivante:

kubectl annotate namespace NAMESPACE_NAME cnrm.cloud.google.com/project-id=PROJECT_ID

Remplacez les éléments suivants :

  • NAMESPACE_NAME : nom de votre espace de noms
  • PROJECT_ID : ID de votre projet Google Cloud

Vous pouvez également appliquer un fichier manifeste YAML contenant l'annotation. Copiez le manifeste YAML ci-dessous dans un fichier :

apiVersion: v1
kind: Namespace
metadata:
  annotations:
    cnrm.cloud.google.com/project-id: PROJECT_ID
  name: NAMESPACE_NAME

Remplacez les éléments suivants :

  • PROJECT_ID : ID de votre projet Google Cloud
  • NAMESPACE_NAME : nom de votre espace de noms

Après avoir créé le fichier, appliquez-le à votre cluster.

Utiliser le nom de l'espace de noms comme ID de projet

Si ni la ressource ni l'espace de noms ne spécifient d'ID de projet, Config Connector utilise le nom de l'espace de noms comme ID de projet. Ce comportement par défaut est compatible avec Config Connector, mais nous ne le recommandons pas, car la valeur par défaut implicite de l'ID de projet peut prêter à confusion.