Exécuter Milvus dans Kubernetes avec Milvus Operator

Cette page explique comment démarrer une instance Milvus dans Kubernetes à l'aide de Milvus Operator.

Vue d'ensemble

Milvus Operator est une solution qui vous aide à déployer et à gérer une pile de services Milvus complète pour cibler les clusters Kubernetes (K8s). La pile comprend tous les composants Milvus et les dépendances pertinentes telles que etcd, Pulsar et MinIO.

Conditions préalables

  • Créer un cluster K8s.

  • Installer une StorageClass. Vous pouvez vérifier la StorageClass installée comme suit.

    $ kubectl get sc
    
    NAME                  PROVISIONER                  RECLAIMPOLICY    VOLUMEBIINDINGMODE    ALLOWVOLUMEEXPANSION     AGE
    standard (default)    k8s.io/minikube-hostpath     Delete           Immediate             false 
    
  • Vérifier la configuration matérielle et logicielle requise avant l'installation.

  • Avant d'installer Milvus, il est recommandé d'utiliser l'outil de dimensionnement Milvus pour estimer la configuration matérielle requise en fonction de la taille de vos données. Cela permet de garantir des performances et une allocation de ressources optimales pour l'installation de Milvus.

Si vous rencontrez des problèmes en tirant l'image, contactez-nous à l'adresse community@zilliz.com en précisant le problème, et nous vous fournirons l'assistance nécessaire.

Installer l'opérateur Milvus

Milvus Operator définit les ressources personnalisées d'un cluster Milvus au-dessus des ressources personnalisées de Kubernetes. Lorsque des ressources personnalisées sont définies, vous pouvez utiliser les API K8s de manière déclarative et gérer la pile de déploiement Milvus pour garantir son évolutivité et sa haute disponibilité.

Exécutez la commande suivante pour installer Milvus Operator avec Helm.

$ helm install milvus-operator \
  -n milvus-operator --create-namespace \
  --wait --wait-for-jobs \
  https://github.com/zilliztech/milvus-operator/releases/download/v1.3.0/milvus-operator-1.3.0.tgz

Une fois le processus d'installation terminé, vous obtiendrez un résultat similaire à celui qui suit.

NAME: milvus-operator
LAST DEPLOYED: Thu Jul  7 13:18:40 2022
NAMESPACE: milvus-operator
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Milvus Operator Is Starting, use `kubectl get -n milvus-operator deploy/milvus-operator` to check if its successfully installed
If Operator not started successfully, check the checker's log with `kubectl -n milvus-operator logs job/milvus-operator-checker`
Full Installation doc can be found in https://github.com/zilliztech/milvus-operator/blob/main/docs/installation/installation.md
Quick start with `kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/main/config/samples/milvus_minimum.yaml`
More samples can be found in https://github.com/zilliztech/milvus-operator/tree/main/config/samples
CRD Documentation can be found in https://github.com/zilliztech/milvus-operator/tree/main/docs/CRD

Si vous avez déjà installé Milvus Operator, mettez-le à niveau à l'aide de la commande suivante :

helm upgrade milvus-operator \
  -n milvus-operator --create-namespace \
  --wait --wait-for-jobs \
  https://github.com/zilliztech/milvus-operator/releases/download/v1.3.0/milvus-operator-1.3.0.tgz

Exécutez la commande suivante pour installer Milvus Operator avec kubectl.

$ kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/main/deploy/manifests/deployment.yaml

Vous obtiendrez un résultat similaire au suivant à la fin du processus d'installation.

namespace/milvus-operator created
customresourcedefinition.apiextensions.k8s.io/milvusclusters.milvus.io created
serviceaccount/milvus-operator-controller-manager created
role.rbac.authorization.k8s.io/milvus-operator-leader-election-role created
clusterrole.rbac.authorization.k8s.io/milvus-operator-manager-role created
clusterrole.rbac.authorization.k8s.io/milvus-operator-metrics-reader created
clusterrole.rbac.authorization.k8s.io/milvus-operator-proxy-role created
rolebinding.rbac.authorization.k8s.io/milvus-operator-leader-election-rolebinding created
clusterrolebinding.rbac.authorization.k8s.io/milvus-operator-manager-rolebinding created
clusterrolebinding.rbac.authorization.k8s.io/milvus-operator-proxy-rolebinding created
configmap/milvus-operator-manager-config created
service/milvus-operator-controller-manager-metrics-service created
service/milvus-operator-webhook-service created
deployment.apps/milvus-operator-controller-manager created

Vous pouvez vérifier si le pod Milvus Operator est en cours d'exécution en procédant comme suit :

$ kubectl get pods -n milvus-operator

NAME                               READY   STATUS    RESTARTS   AGE
milvus-operator-5fd77b87dc-msrk4   1/1     Running   0          46s

Déployer Milvus

1. Déployer un cluster Milvus

Une fois que le pod Milvus Operator fonctionne, vous pouvez déployer un cluster Milvus comme suit.

$ kubectl apply -f https://raw.githubusercontent.com/zilliztech/milvus-operator/main/config/samples/milvus_cluster_woodpecker.yaml

La commande ci-dessus déploie un cluster Milvus avec Woodpecker comme file d'attente de messages (recommandé pour la version 2.6.16) et tous les nouveaux composants architecturaux, y compris le nœud de streaming.

Points forts de l'architecture dans ce déploiement :

  • File d'attente de messages: Utilise Woodpecker (réduit la maintenance de l'infrastructure)
  • Nœud de diffusion en continu: Activé pour un meilleur traitement des données
  • Coordinateur mixte: Composants du coordinateur consolidés pour une meilleure efficacité

Pour personnaliser ces paramètres, nous vous recommandons d'utiliser l'outil de dimensionnement Milvus pour ajuster les configurations en fonction de la taille réelle de vos données, puis de télécharger le fichier YAML correspondant. Pour en savoir plus sur les paramètres de configuration, reportez-vous à la liste de contrôle des configurations du système Milvus.

  • Le nom de la version ne doit contenir que des lettres, des chiffres et des tirets. Les points ne sont pas autorisés dans le nom de la version.
  • Vous pouvez également déployer une instance Milvus en mode autonome, où tous ses composants sont contenus dans un seul pod. Pour ce faire, modifiez l'URL du fichier de configuration dans la commande ci-dessus en https://raw.githubusercontent.com/zilliztech/milvus-operator/main/config/samples/milvus_default.yaml

2. Vérifier l'état du cluster Milvus

Exécutez la commande suivante pour vérifier l'état du cluster Milvus

$ kubectl get milvus my-release -o yaml

Une fois que votre cluster Milvus est prêt, la sortie de la commande ci-dessus devrait être similaire à ce qui suit. Si le champ status.status reste à Unhealthy, votre cluster Milvus est toujours en cours de création.

apiVersion: milvus.io/v1alpha1
kind: Milvus
metadata:
...
status:
  conditions:
  - lastTransitionTime: "xxxx-xx-xxTxx:xx:xxZ"
    reason: StorageReady
    status: "True"
    type: StorageReady
  - lastTransitionTime: "xxxx-xx-xxTxx:xx:xxZ"
    message: Pulsar is ready
    reason: PulsarReady
    status: "True"
    type: PulsarReady
  - lastTransitionTime: "xxxx-xx-xxTxx:xx:xxZ"
    message: Etcd endpoints is healthy
    reason: EtcdReady
    status: "True"
    type: EtcdReady
  - lastTransitionTime: "xxxx-xx-xxTxx:xx:xxZ"
    message: All Milvus components are healthy
    reason: MilvusClusterHealthy
    status: "True"
    type: MilvusReady
  endpoint: my-release-milvus.default:19530
  status: Healthy

Milvus Operator crée les dépendances Milvus, telles que etcd, Pulsar et MinIO, puis les composants Milvus, tels que le proxy, les coordinateurs et les nœuds.

Une fois que votre cluster Milvus est prêt, l'état de tous les pods dans le cluster Milvus doit être similaire à ce qui suit.

$ kubectl get pods

NAME                                             READY   STATUS    RESTARTS   AGE
my-release-etcd-0                                1/1     Running   0          2m36s
my-release-etcd-1                                1/1     Running   0          2m36s
my-release-etcd-2                                1/1     Running   0          2m36s
my-release-milvus-datanode-58955c65b9-j4j7s      1/1     Running   0          92s
my-release-milvus-mixcoord-686f84968f-jcv5d      1/1     Running   0          92s
my-release-milvus-proxy-646f48fc7c-4lctb         1/1     Running   0          92s
my-release-milvus-querynode-0-d89d7677b-x7j7q    1/1     Running   0          91s
my-release-milvus-streamingnode-556bdcc87c-2qwcc 1/1     Running   0          92s
my-release-minio-0                               1/1     Running   0          2m36s
my-release-minio-1                               1/1     Running   0          2m36s
my-release-minio-2                               1/1     Running   0          2m35s
my-release-minio-3                               1/1     Running   0          2m35s

3. Transférer un port local vers Milvus

Exécutez la commande suivante pour obtenir le port auquel votre cluster Milvus sert.

$ kubectl get pod my-release-milvus-proxy-84f67cdb7f-pg6wf --template
='{{(index (index .spec.containers 0).ports 0).containerPort}}{{"\n"}}'
19530

La sortie montre que l'instance Milvus dessert le port par défaut 19530.

Si vous avez déployé Milvus en mode autonome, modifiez le nom du pod de my-release-milvus-proxy-xxxxxxxxxx-xxxxx à my-release-milvus-xxxxxxxxxx-xxxxx.

Ensuite, exécutez la commande suivante pour transférer un port local vers le port auquel Milvus sert.

$ kubectl port-forward service/my-release-milvus 27017:19530
Forwarding from 127.0.0.1:27017 -> 19530

En option, vous pouvez utiliser :19530 au lieu de 27017:19530 dans la commande ci-dessus pour permettre à kubectl d'allouer un port local pour vous afin que vous n'ayez pas à gérer les conflits de port.

Par défaut, le port-forwarding de kubectl n'écoute que sur localhost. Utilisez l'indicateur address si vous souhaitez que Milvus écoute sur l'adresse IP sélectionnée ou sur toutes les adresses IP. La commande suivante fait en sorte que port-forward écoute toutes les adresses IP de la machine hôte.

$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27017:19530
Forwarding from 0.0.0.0:27017 -> 19530

Vous pouvez à présent vous connecter à Milvus à l'aide du port transféré.

(Facultatif) Mise à jour des configurations Milvus

Vous pouvez afficher et mettre à jour les configurations de votre cluster Milvus en appelant la commande patch comme suit :

  1. Exécutez la commande suivante pour prévisualiser les configurations potentielles.

    La commande suivante suppose que vous souhaitez mettre à jour le paramètre spec.components.disableMetric en false ms.

    $ kubectl patch milvus my-release --type='merge'\
      -p '{"spec":{"components":{"disableMetric":false}}}' \
      --dry-run=client -o yaml
    

    Pour les éléments de configuration applicables, voir Configuration du système.

  2. Mettre à jour les configurations.

    $ kubectl patch milvus my-release --type='merge'\
      -p '{"spec":{"components":{"disableMetric":false}}}' 
    

Accès à l'interface Web de Milvus

Milvus est livré avec un outil GUI intégré appelé Milvus WebUI auquel vous pouvez accéder via votre navigateur. Milvus WebUI améliore l'observabilité du système grâce à une interface simple et intuitive. Vous pouvez utiliser l'interface Web Milvus pour observer les statistiques et les métriques des composants et des dépendances de Milvus, vérifier les détails de la base de données et de la collection, et répertorier les configurations détaillées de Milvus. Pour plus de détails sur l'interface Web de Milvus, voir l'interface Web de Milvus.

Pour permettre l'accès à l'interface Web Milvus, vous devez rediriger le port du pod proxy vers un port local.

$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27018:9091
Forwarding from 0.0.0.0:27018 -> 9091

Vous pouvez désormais accéder à l'interface Web de Milvus à l'adresse http://localhost:27018.

Désinstaller Milvus

Exécutez la commande suivante pour désinstaller le cluster Milvus.

$ kubectl delete milvus my-release
  • Lorsque vous supprimez le cluster Milvus à l'aide de la configuration par défaut, les dépendances telles que etcd, Pulsar et MinIO ne sont pas supprimées. Par conséquent, la prochaine fois que vous installerez la même instance de cluster Milvus, ces dépendances seront à nouveau utilisées.
  • Pour supprimer les dépendances et les réclamations de volumes persistants (PVC) en même temps que le cluster Milvus, voir le fichier de configuration.

Désinstallation de Milvus Operator

Il existe également deux façons de désinstaller Milvus Operator.

Désinstallation avec Helm

$ helm -n milvus-operator uninstall milvus-operator

Désinstallation avec kubectl

$ kubectl delete -f https://raw.githubusercontent.com/zilliztech/milvus-operator/v1.3.0/deploy/manifests/deployment.yaml

Ce qui suit

Après avoir installé Milvus dans Docker, vous pouvez :