Utiliser des déploiements de fonctionnalités progressifs

Ce guide explique comment configurer et exécuter un déploiement progressif de fonctionnalités à l'aide des flags de fonctionnalité d'App Lifecycle Manager. Vous apprendrez à définir des attributs de ciblage, à configurer des allocations basées sur des pourcentages et à exécuter un déploiement progressif en toute sécurité.

Nous allons utiliser un scénario dans lequel vous souhaitez activer un algorithme enhanced-search pour seulement 1 % de votre trafic, sélectionné de manière aléatoire par l'attribut userID, tandis que les 99 % restants continuent d'utiliser la recherche standard.

Prérequis

Avant de commencer, assurez-vous d'avoir suivi l'un des guides de démarrage rapide standards pour provisionner votre infrastructure de référence ou vos ressources de flags de fonctionnalité autonomes :

Intégrer l'indicateur dans votre application

Pour prendre en charge les allocations basées sur un pourcentage et basées sur les données utilisateur, votre application doit associer la valeur de l'attribut (par exemple, userID) au contexte d'évaluation OpenFeature au moment de l'exécution avant d'appeler la méthode d'évaluation.

Les exemples suivants montrent comment récupérer le client initialisé et évaluer le flag avec le contexte de ciblage associé.

Go

import (
    "context"
    "fmt"
    "log"

    "github.com/open-feature/go-sdk/openfeature"
)

// Example userID - in a real application, this would come from the request context.
var userID = "example-user-123"

// 1. Get client
client := openfeature.NewClient("simple-api")

// 2. Create Evaluation Context with user data
evalCtx := openfeature.NewEvaluationContext(
    userID,
    map[string]interface{}{
        "userID": userID, // Ensure userID is passed dynamically
    },
)

// 3. Evaluate flag (defaults to false if unreachable)
isEnhanced, err := client.BooleanValue(context.Background(), "enhanced-search", false, evalCtx)
if err != nil {
    log.Printf("Flag evaluation failed: %v", err)
}

// 4. Execute business logic
if isEnhanced {
    log.Printf("Enhanced search algorithm for user %s", userID)
} else {
    log.Printf("Standard search algorithm for user %s", userID)
}

Java

// 1. Get client
var client = OpenFeatureAPI.getInstance().getClient("simple-api");

// 2. Create Evaluation Context with user data
var context = new dev.openfeature.sdk.MutableContext();
context.add("userID", userID);

// 3. Evaluate flag
boolean isEnhanced = client.getBooleanValue("enhanced-search", false, context);

// 4. Execute business logic
if (isEnhanced) {
    System.out.println("Executing enhanced search algorithm...");
} else {
    System.out.println("Executing standard search algorithm...");
}

Python

import openfeature
from openfeature.evaluation_context import EvaluationContext

# 1. Get client
client = openfeature.api.get_client()

# 2. Create Evaluation Context with user data
eval_ctx = EvaluationContext(
    targeting_key=str(user_id),
    attributes={
        "userID": user_id,
    }
)

# 3. Evaluate flag
is_enhanced = client.get_boolean_value(
    "enhanced-search",
    False,
    eval_ctx
)

# 4. Execute business logic
if is_enhanced:
    print(f"Executing enhanced search for user {user_id}")
else:
    print(f"Executing standard search for user {user_id}")

Configurer le comportement des flags

Définissez le paramètre d'attribut aléatoire et associez-le à une règle d'allocation basée sur un pourcentage sur la ressource de flag de fonctionnalité.

  1. Créer l'attribut de ciblage : définissez la ressource d'attribut userID de manière globale pour l'enregistrer pour l'évaluation du ciblage.

    gcloud beta app-lifecycle-manager flags attributes create "user-id-attr" \
      --key="userID" \
      --attribute-value-type="STRING" \
      --location="global"
    
  2. Définissez la règle d'allocation du flag : créez la ressource de flag de fonctionnalité pour attribuer une pondération de 1 % à la variante enabled randomisée sur userID.

    gcloud beta app-lifecycle-manager flags create "enhanced-search" \
      --key="enhanced-search" \
      --flag-value-type=bool \
      --location="global" \
      --unit-kind="demo-test-unitkind" \
      --variants='[ { "id": "disabled", "booleanValue": false }, { "id": "enabled", "booleanValue": true } ]' \
      --evaluation-spec='{
        "allocations": [{
          "id": "percentage-rollout",
          "randomizedOn": "userID",
          "slots": [
            {"variant": "disabled", "weight": 99},
            {"variant": "enabled", "weight": 1}
          ]
        }],
        "defaultAllocation": "percentage-rollout",
        "attributes": ["projects/PROJECT_ID/locations/global/flagAttributes/user-id-attr"]
      }'
    

Créer un déploiement de configuration de flag

Pour distribuer la règle d'allocation progressive que vous venez de créer en toute sécurité, suivez les phases de déploiement immuables standards.

  1. Créer une révision : capturez un instantané de la configuration d'allocation de 1 %.

    gcloud beta app-lifecycle-manager flags revisions create "enhanced-search-rev-1" \
       --location="global" \
       --flag="enhanced-search"
    
  2. Créer une version : empaquetez la révision pour la déployer sur vos types d'unités.

    gcloud beta app-lifecycle-manager flags releases create "release-of-enhanced-search" \
       --location="global" \
       --unit-kind="demo-test-unitkind" \
       --revisions="enhanced-search-rev-1"
    
  3. Lancer le déploiement : définissez votre stratégie d'orchestration et déployez la configuration.

    gcloud beta app-lifecycle-manager rollout-kinds create "rollout-kind-of-enhanced-search" \
       --unit-kind="demo-test-unitkind" \
       --rollout-orchestration-strategy="Google.Cloud.Simple.AllAtOnce" \
       --location="global"
    
    gcloud beta app-lifecycle-manager rollouts create "rollout-of-enhanced-search" \
       --flag-release="release-of-enhanced-search" \
       --rollout-kind="rollout-kind-of-enhanced-search" \
       --location="global"
    
  4. Surveillez le déploiement : vérifiez que le déploiement atteint l'état SUCCEEDED.

    gcloud beta app-lifecycle-manager rollouts describe "rollout-of-enhanced-search" \
       --location="global"
    

Mettre à jour le ciblage des flags

Une fois que le déploiement à 1 % est considéré comme réussi et stable, augmentez le pourcentage d'audience en mettant à jour la pondération d'allocation interne du flag (par exemple, à 50 %).

  1. Mettre à jour la spécification de l'indicateur : modifiez les emplacements d'allocation pour qu'ils soient activés à 50 % et désactivés à 50 %.

    gcloud beta app-lifecycle-manager flags update "enhanced-search" \
      --location="global" \
      --evaluation-spec='{
        "allocations": [{
          "id": "percentage-rollout",
          "randomizedOn": "userID",
          "slots": [
            {"variant": "disabled", "weight": 50},
            {"variant": "enabled", "weight": 50}
          ]
        }],
        "defaultAllocation": "percentage-rollout",
        "attributes": ["projects/PROJECT_ID/locations/global/flagAttributes/user-id-attr"]
      }'
    
  2. Déployer l'extension : suivez le cycle de vie pour distribuer la pondération mise à jour aux clients connectés.

    gcloud beta app-lifecycle-manager flags revisions create "enhanced-search-rev-2" \
       --location="global" \
       --flag="enhanced-search"
    
    gcloud beta app-lifecycle-manager flags releases create "enhanced-search-50pct" \
       --location="global" \
       --unit-kind="demo-test-unitkind" \
       --revisions="enhanced-search-rev-2"
    
    gcloud beta app-lifecycle-manager rollouts create "rollout-of-enhanced-search-50pct" \
       --flag-release="enhanced-search-50pct" \
       --rollout-kind="rollout-kind-of-enhanced-search" \
       --location="global"
    

    Cette opération peut être répétée en continu jusqu'à ce que la fonctionnalité soit déployée à 100 %.

Mettre hors service un flag

Une fois qu'un flag de fonctionnalité a terminé son déploiement et qu'il sert de comportement opérationnel standard, il doit être mis hors service de manière sécurisée.

  1. Supprimer de l'application : supprimez toute la logique conditionnelle d'évaluation des indicateurs de la codebase de votre application et déployez la charge utile mise à jour en production.
  2. Marquer pour nettoyage : définissez l'état de l'option sur CLEANUP pour signaler l'intention de la déprovisionner :

    gcloud beta app-lifecycle-manager flags update "enhanced-search" \
        --location="global" \
        --state=cleanup
    
  3. Déployer le déploiement final : créez une version de flag faisant référence au flag et déployez-la pour dissocier le flag de vos unités :

    gcloud beta app-lifecycle-manager flags releases create "cleanup-enhanced-search" \
        --location="global" \
        --unit-kind="demo-test-unitkind" \
        --flags="enhanced-search"
    
    gcloud beta app-lifecycle-manager rollouts create "rollout-of-cleanup-enhanced-search" \
        --flag-release="cleanup-enhanced-search" \
        --rollout-kind="rollout-kind-of-enhanced-search" \
        --location="global"
    

    Une fois le déploiement terminé, supprimez la version du flag, les révisions du flag et le flag du plan de gestion.