Usar restricciones de políticas de costes y fiabilidad

Policy Controller incluye una biblioteca predeterminada de plantillas de restricciones que se pueden usar con el paquete de políticas de costes y fiabilidad, que ayuda a adoptar prácticas recomendadas para ejecutar clústeres de GKE rentables sin comprometer el rendimiento ni la fiabilidad de sus cargas de trabajo.

En esta página se explica cómo aplicar manualmente un paquete de políticas. También puedes aplicar paquetes de políticas directamente.

Advertencia: Después de elegir un método para aplicar paquetes de políticas (manual, gcloud CLI o consola Google Cloud ), usar otro método para instalar paquetes de políticas puede provocar errores en tu entorno.

Restricciones del paquete de políticas de costes y fiabilidad

Nombre de la restricción	Descripción de la restricción
cost-reliability-v2023-pod-disruption-budget	Requiere la configuración de PodDisruptionBudget para Deployments, ReplicaSets, StatefulSets y ReplicationControllers.
cost-reliability-v2023-pod-resources-best-practices	Requiere que los contenedores definan solicitudes de recursos y sigan las prácticas recomendadas.
cost-reliability-v2023-required-labels	Requiere que todos los pods y controladores (ReplicaSet, Deployment, StatefulSet y DaemonSet) tengan las etiquetas necesarias: environment, team y app.
cost-reliability-v2023-restrict-repos	Restringe las imágenes de contenedor a una lista de repositorios permitidos para usar Artifact Registry y aprovechar las ventajas del streaming de imágenes.
cost-reliability-v2023-spotvm-termination-grace	Requiere un valor de terminationGracePeriodSeconds de 15 s o menos para los pods y las plantillas de pods con un valor de nodeSelector o nodeAffinity para gke-spot.

Antes de empezar

1. Instala e inicializa la CLI de Google Cloud, que proporciona los comandos gcloud y kubectl que se usan en estas instrucciones. Si usas Cloud Shell, Google Cloud CLI viene preinstalada.
2. Instala Policy Controller en tu clúster con la biblioteca predeterminada de plantillas de restricciones. También debes habilitar la compatibilidad con las restricciones referenciales, ya que este paquete contiene restricciones referenciales.

Configurar Policy Controller para las restricciones referenciales

Advertencia: Puedes sobrescribir los cambios. Si ya tiene un Config en el espacio de nombres gatekeeper-system, debe incluir todos los ajustes de personalización anteriores para conservar los cambios.

1. Guarda el siguiente manifiesto YAML en un archivo con el nombre policycontroller-config.yaml. El manifiesto configura Policy Controller para que monitorice tipos específicos de objetos.

   apiVersion: config.gatekeeper.sh/v1alpha1
   kind: Config
   metadata:
     name: config
     namespace: "gatekeeper-system"
   spec:
     sync:
       syncOnly:
         - group: ""
           version: "v1"
           kind: "Service"
         - group: "policy"
           version: "v1"
           kind: "PodDisruptionBudget"
   

2. Aplica el manifiesto policycontroller-config.yaml:

   kubectl apply -f policycontroller-config.yaml
   

Configurar el clúster y la carga de trabajo

1. Cualquier pod seleccionado por un service debe incluir sondas de disponibilidad.
2. Todos los deployment, replicaset, statefulset y replicationcontroller deben incluir un poddisruptionbudget.
3. Todos los contenedores deben incluir solicitudes cpu y memory, y el límite de memory debe ser igual al número de solicitudes memory, siguiendo las prácticas recomendadas.
4. Añade las etiquetas environment, team y app a todos los pods y plantillas de pods.
5. Aloja imágenes de contenedor con Artifact Registry en la misma región que tu clúster para habilitar Image streaming. Permite el Artifact Registry correspondiente siguiendo el ejemplo de cost-reliability-v2023-restrict-repos.
6. Todos los pods y las plantillas de pods que usen gke-spot deben incluir un terminationGracePeriodSeconds de 15 segundos o menos.

Paquete de políticas de costes y fiabilidad de auditorías

Policy Controller te permite aplicar políticas en tu clúster de Kubernetes. Para ayudarte a probar tus cargas de trabajo y su cumplimiento de las políticas de costes y fiabilidad que se describen en la tabla anterior, puedes implementar estas restricciones en modo "auditoría" para detectar infracciones y, lo que es más importante, tener la oportunidad de corregirlas antes de aplicarlas en tu clúster de Kubernetes.

Puedes aplicar estas políticas con spec.enforcementAction definido como dryrun mediante kubectl, kpt o Config Sync.

kubectl

1. (Opcional) Obtén una vista previa de las restricciones de la política con kubectl:

   kubectl kustomize https://github.com/GoogleCloudPlatform/gke-policy-library.git/anthos-bundles/cost-reliability-v2023
   

2. Aplica las restricciones de la política con kubectl:

   kubectl apply -k https://github.com/GoogleCloudPlatform/gke-policy-library.git/anthos-bundles/cost-reliability-v2023
   

   El resultado es el siguiente:

   gkespotvmterminationgrace.constraints.gatekeeper.sh/cost-reliability-v2023-spotvm-termination-grace created
   k8sallowedrepos.constraints.gatekeeper.sh/cost-reliability-v2023-restrict-repos created
   k8spoddisruptionbudget.constraints.gatekeeper.sh/cost-reliability-v2023-pod-disruption-budget created
   k8spodresourcesbestpractices.constraints.gatekeeper.sh/cost-reliability-v2023-pod-resources-best-practices created
   k8srequiredlabels.constraints.gatekeeper.sh/cost-reliability-v2023-required-labels created
   

3. Verifica que se hayan instalado las restricciones de la política y comprueba si hay infracciones en el clúster:

   kubectl get constraints -l policycontroller.gke.io/bundleName=cost-reliability-v2023
   

   El resultado debería ser similar al siguiente:

   NAME                                                                                                  ENFORCEMENT-ACTION   TOTAL-VIOLATIONS
   gkespotvmterminationgrace.constraints.gatekeeper.sh/cost-reliability-v2023-spotvm-termination-grace   dryrun               0
   
   NAME                                                                                                         ENFORCEMENT-ACTION   TOTAL-VIOLATIONS
   k8spodresourcesbestpractices.constraints.gatekeeper.sh/cost-reliability-v2023-pod-resources-best-practices   dryrun               0
   
   NAME                                                                                            ENFORCEMENT-ACTION   TOTAL-VIOLATIONS
   k8spoddisruptionbudget.constraints.gatekeeper.sh/cost-reliability-v2023-pod-disruption-budget   dryrun               0
   
   NAME                                                                              ENFORCEMENT-ACTION   TOTAL-VIOLATIONS
   k8sallowedrepos.constraints.gatekeeper.sh/cost-reliability-v2023-restrict-repos   dryrun               0
   
   NAME                                                                                 ENFORCEMENT-ACTION   TOTAL-VIOLATIONS
   k8srequiredlabels.constraints.gatekeeper.sh/cost-reliability-v2023-required-labels   dryrun               0
   

KPT

1. Instala y configura kpt.

   kpt se usa en estas instrucciones para personalizar y desplegar recursos de Kubernetes.

2. Descarga el paquete de políticas PCI DSS v3.2.1 de GitHub con kpt:

   kpt pkg get https://github.com/GoogleCloudPlatform/gke-policy-library.git/anthos-bundles/cost-reliability-v2023
   

3. Ejecuta la función set-enforcement-action kpt para definir la acción de aplicación de las políticas en dryrun:

   kpt fn eval cost-reliability-v2023 -i gcr.io/kpt-fn/set-enforcement-action:v0.1 \
   -- enforcementAction=dryrun
   

4. Inicializa el directorio de trabajo con kpt, que crea un recurso para monitorizar los cambios:

   cd cost-reliability-v2023 kpt live init
   

5. Aplica las restricciones de la política con kpt:

   kpt live apply
   

6. Verifica que se hayan instalado las restricciones de la política y comprueba si hay infracciones en el clúster:

   kpt live status --output table --poll-until current
   

   El estado CURRENT confirma que las restricciones se han instalado correctamente.

Config Sync

1. Instala y configura kpt.

   kpt se usa en estas instrucciones para personalizar y desplegar recursos de Kubernetes.

   Los operadores que usen Config Sync para implementar políticas en sus clústeres pueden seguir estas instrucciones:

2. Cambia al directorio de sincronización de Config Sync:

   cd SYNC_ROOT_DIR
   

   Nota: Kpt v1.0.0-beta.17 y versiones posteriores crean automáticamente un archivo resourcegroup.yaml durante live init, que no se debe registrar en tu repositorio de Config Sync. Si aún no está presente, añade resourcegroup.yaml al archivo .gitignore de tu repositorio.

   Para crear o añadir .gitignore con resourcegroup.yaml, sigue estos pasos:

   echo resourcegroup.yaml >> .gitignore
   

3. Crea un directorio policies específico:

   mkdir -p policies
   

4. Descarga el paquete de políticas de costes y fiabilidad de GitHub con kpt:

   kpt pkg get https://github.com/GoogleCloudPlatform/gke-policy-library.git/anthos-bundles/cost-reliability-v2023 policies/cost-reliability-v2023
   

5. Ejecuta la función set-enforcement-action kpt para definir la acción de aplicación de las políticas en dryrun:

   kpt fn eval policies/cost-reliability-v2023 -i gcr.io/kpt-fn/set-enforcement-action:v0.1 -- enforcementAction=dryrun
   

6. (Opcional) Obtén una vista previa de las restricciones de la política que se van a crear:

   kpt live init policies/cost-reliability-v2023
   kpt live apply --dry-run policies/cost-reliability-v2023
   

7. Si el directorio de sincronización de Config Sync usa Kustomize, añade policies/cost-reliability-v2023 a tu raíz kustomization.yaml. De lo contrario, elimina el archivo policies/cost-reliability-v2023/kustomization.yaml:

   rm SYNC_ROOT_DIR/policies/cost-reliability-v2023/kustomization.yaml
   

8. Envía los cambios al repositorio de Config Sync:

   git add SYNC_ROOT_DIR/policies/cost-reliability-v2023 git commit -m 'Adding Cost and Reliability policy audit enforcement'
   git push
   

9. Verifica el estado de la instalación:

   watch gcloud beta container fleet config-management status --project PROJECT_ID
   

   El estado SYNCED confirma la instalación de las políticas.

Ver las infracciones de las políticas

Una vez que las restricciones de la política se hayan instalado en el modo de auditoría, las infracciones del clúster se podrán ver en la interfaz de usuario mediante el panel de control de Policy Controller.

También puedes usar kubectl para ver las infracciones del clúster con el siguiente comando:

  kubectl get constraint -l policycontroller.gke.io/bundleName=cost-reliability-v2023 -o json | jq -cC '.items[]| [.metadata.name,.status.totalViolations]'
  

Si hay infracciones, se puede ver una lista de los mensajes de infracción por restricción con:

  kubectl get constraint -l policycontroller.gke.io/bundleName=cost-reliability-v2023 -o json | jq -C '.items[]| select(.status.totalViolations>0)| [.metadata.name,.status.violations[]?]'
  

Cambiar la medida de refuerzo del paquete de políticas de costes y fiabilidad

Una vez que hayas revisado las infracciones de las políticas en tu clúster, puedes cambiar el modo de aplicación para que el controlador de admisión warn se active o incluso deny bloquee la aplicación de recursos no conformes al clúster.

Advertencia: La acción de cumplimiento de deny debe usarse con precaución, ya que puede bloquear cambios necesarios y provocar interrupciones en cargas de trabajo críticas o en el clúster. Te recomendamos que solo uses las acciones de cumplimiento warn o dryrun en clústeres con cargas de trabajo de producción, cuando pruebes nuevas restricciones o realices migraciones, como la actualización de plataformas. Para obtener más información sobre las medidas de cumplimiento, consulta el artículo Auditorías con restricciones

.

kubectl

1. Usa kubectl para definir la acción de aplicación de las políticas como warn:

   kubectl get constraints -l policycontroller.gke.io/bundleName=cost-reliability-v2023 -o name | xargs -I {} kubectl patch {} --type='json' -p='[{"op":"replace","path":"/spec/enforcementAction","value":"warn"}]'
   

2. Verifica que se haya actualizado la medida de implementación de las restricciones de la política:

   kubectl get constraints -l policycontroller.gke.io/bundleName=cost-reliability-v2023
   

KPT

1. Ejecuta la función set-enforcement-action kpt para definir la acción de aplicación de las políticas en warn:

   kpt fn eval -i gcr.io/kpt-fn/set-enforcement-action:v0.1 -- enforcementAction=warn
   

2. Aplica las restricciones de la política:

   kpt live apply
   

Config Sync

Los operadores que usen Config Sync para implementar políticas en sus clústeres pueden seguir estas instrucciones:

1. Cambia al directorio de sincronización de Config Sync:

   cd SYNC_ROOT_DIR
   

2. Ejecuta la función set-enforcement-action kpt para definir la acción de aplicación de las políticas en warn:

   kpt fn eval policies/cost-reliability-v2023 -i gcr.io/kpt-fn/set-enforcement-action:v0.1 -- enforcementAction=warn
   

3. Envía los cambios al repositorio de Config Sync:

   git add SYNC_ROOT_DIR/policies/cost-reliability-v2023
   git commit -m 'Adding Cost and Reliability policy bundle warn enforcement'
   git push
   

4. Verifica el estado de la instalación:

   nomos status
   

   El clúster debería mostrar el estado SYNCED con las políticas instaladas.

Probar la aplicación de las políticas

Crea un recurso no conforme en el clúster con el siguiente comando:

cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Pod
metadata:
  namespace: default
  name: wp-non-compliant
  labels:
    app: wordpress
spec:
  containers:
    - image: wordpress
      name: wordpress
      ports:
      - containerPort: 80
        hostPort: 80
        name: wordpress
EOF

El controlador de admisión debe generar una advertencia en la que se enumeren las infracciones de la política que comete este recurso, como se muestra en el siguiente ejemplo:

Warning: [cost-reliability-v2023-pod-resources-best-practices] Container <wordpress> must set <cpu> request.
Warning: [cost-reliability-v2023-pod-resources-best-practices] Container <wordpress> must set <memory> request.
Warning: [cost-reliability-v2023-required-labels] This app is missing one or more required labels: `environment`, `team`, and `app`.
Warning: [cost-reliability-v2023-restrict-repos] container <wordpress> has an invalid image repo <wordpress>, allowed repos are ["gcr.io/gke-release/", "gcr.io/anthos-baremetal-release/", "gcr.io/config-management-release/", "gcr.io/kubebuilder/", "gcr.io/gkeconnect/", "gke.gcr.io/"]
pod/wp-non-compliant created

Eliminar el paquete de políticas de costes y fiabilidad

Si es necesario, el paquete de políticas de costes y fiabilidad se puede quitar del clúster.

kubectl

Usa kubectl para eliminar las políticas:

  kubectl delete constraint -l policycontroller.gke.io/bundleName=cost-reliability-v2023
  

KPT

Elimina las políticas:

  kpt live destroy
  

Config Sync

Los operadores que usen Config Sync para implementar políticas en sus clústeres pueden seguir estas instrucciones:

1. Envía los cambios al repositorio de Config Sync:

   git rm -r SYNC_ROOT_DIR/policies/cost-reliability-v2023
   git commit -m 'Removing Cost and Reliability policies'
   git push
   

2. Verifica el estado:

   nomos status
   

   El clúster debería mostrar el estado SYNCED con los recursos eliminados.