// _ _ // __ _____ __ ___ ___ __ _| |_ ___ // \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \ // \ V V / __/ (_| |\ V /| | (_| | || __/ // \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___| // // Copyright © 2016 - 2025 Weaviate B.V. All rights reserved. // // CONTACT: hello@weaviate.io // package docker import ( "context" "fmt" "os" "slices" "strconv" "strings" "time" "github.com/pkg/errors" tescontainersnetwork "github.com/testcontainers/testcontainers-go/network" "golang.org/x/sync/errgroup" modstgazure "github.com/weaviate/weaviate/modules/backup-azure" modstgfilesystem "github.com/weaviate/weaviate/modules/backup-filesystem" modstggcs "github.com/weaviate/weaviate/modules/backup-gcs" modstgs3 "github.com/weaviate/weaviate/modules/backup-s3" modgenerativeanthropic "github.com/weaviate/weaviate/modules/generative-anthropic" modgenerativeanyscale "github.com/weaviate/weaviate/modules/generative-anyscale" modgenerativeaws "github.com/weaviate/weaviate/modules/generative-aws" modgenerativecohere "github.com/weaviate/weaviate/modules/generative-cohere" modgenerativefriendliai "github.com/weaviate/weaviate/modules/generative-friendliai" modgenerativegoogle "github.com/weaviate/weaviate/modules/generative-google" modgenerativenvidia "github.com/weaviate/weaviate/modules/generative-nvidia" modgenerativeollama "github.com/weaviate/weaviate/modules/generative-ollama" modgenerativeopenai "github.com/weaviate/weaviate/modules/generative-openai" modgenerativexai "github.com/weaviate/weaviate/modules/generative-xai" modmulti2multivecjinaai "github.com/weaviate/weaviate/modules/multi2multivec-jinaai" modmulti2veccohere "github.com/weaviate/weaviate/modules/multi2vec-cohere" modmulti2vecgoogle "github.com/weaviate/weaviate/modules/multi2vec-google" modmulti2vecjinaai "github.com/weaviate/weaviate/modules/multi2vec-jinaai" modmulti2vecnvidia "github.com/weaviate/weaviate/modules/multi2vec-nvidia" modmulti2vecvoyageai "github.com/weaviate/weaviate/modules/multi2vec-voyageai" modsloads3 "github.com/weaviate/weaviate/modules/offload-s3" modqnaopenai "github.com/weaviate/weaviate/modules/qna-openai" modrerankercohere "github.com/weaviate/weaviate/modules/reranker-cohere" modrerankernvidia "github.com/weaviate/weaviate/modules/reranker-nvidia" modrerankervoyageai "github.com/weaviate/weaviate/modules/reranker-voyageai" modtext2colbertjinaai "github.com/weaviate/weaviate/modules/text2multivec-jinaai" modaws "github.com/weaviate/weaviate/modules/text2vec-aws" modcohere "github.com/weaviate/weaviate/modules/text2vec-cohere" modgoogle "github.com/weaviate/weaviate/modules/text2vec-google" modhuggingface "github.com/weaviate/weaviate/modules/text2vec-huggingface" modjinaai "github.com/weaviate/weaviate/modules/text2vec-jinaai" modmistral "github.com/weaviate/weaviate/modules/text2vec-mistral" modmodel2vec "github.com/weaviate/weaviate/modules/text2vec-model2vec" modnvidia "github.com/weaviate/weaviate/modules/text2vec-nvidia" modollama "github.com/weaviate/weaviate/modules/text2vec-ollama" modopenai "github.com/weaviate/weaviate/modules/text2vec-openai" modvoyageai "github.com/weaviate/weaviate/modules/text2vec-voyageai" modweaviateembed "github.com/weaviate/weaviate/modules/text2vec-weaviate" ) const ( // envTestWeaviateImage can be passed to tests to spin up docker compose with given image envTestWeaviateImage = "TEST_WEAVIATE_IMAGE" // envTestText2vecTransformersImage adds ability to pass a custom image to module tests envTestText2vecTransformersImage = "TEST_TEXT2VEC_TRANSFORMERS_IMAGE" // envTestText2vecContextionaryImage adds ability to pass a custom image to module tests envTestText2vecContextionaryImage = "TEST_TEXT2VEC_CONTEXTIONARY_IMAGE" // envTestQnATransformersImage adds ability to pass a custom image to module tests envTestQnATransformersImage = "TEST_QNA_TRANSFORMERS_IMAGE" // envTestSUMTransformersImage adds ability to pass a custom image to module tests envTestSUMTransformersImage = "TEST_SUM_TRANSFORMERS_IMAGE" // envTestMulti2VecCLIPImage adds ability to pass a custom CLIP image to module tests envTestMulti2VecCLIPImage = "TEST_MULTI2VEC_CLIP_IMAGE" // envTestMulti2VecBindImage adds ability to pass a custom BIND image to module tests envTestMulti2VecBindImage = "TEST_MULTI2VEC_BIND_IMAGE" // envTestImg2VecNeuralImage adds ability to pass a custom Im2Vec Neural image to module tests envTestImg2VecNeuralImage = "TEST_IMG2VEC_NEURAL_IMAGE" // envTestRerankerTransformersImage adds ability to pass a custom image to module tests envTestRerankerTransformersImage = "TEST_RERANKER_TRANSFORMERS_IMAGE" // envTestText2vecModel2VecImage adds ability to pass a custom image to module tests envTestText2vecModel2VecImage = "TEST_TEXT2VEC_MODEL2VEC_IMAGE" // envTestMockOIDCImage adds ability to pass a custom image to module tests envTestMockOIDCImage = "TEST_MOCKOIDC_IMAGE" // envTestMockOIDCHelperImage adds ability to pass a custom image to module tests envTestMockOIDCHelperImage = "TEST_MOCKOIDC_HELPER_IMAGE" ) const ( Ref2VecCentroid = "ref2vec-centroid" ) type Compose struct { enableModules []string defaultVectorizerModule string withMinIO bool withGCS bool withAzurite bool withBackendFilesystem bool withBackendS3 bool withBackendS3Buckets map[string]string withBackupS3Bucket string withOffloadS3Bucket string withBackendGCS bool withBackendGCSBucket string withBackendAzure bool withBackendAzureContainer string withTransformers bool withTransformersImage string withModel2Vec bool withContextionary bool withQnATransformers bool withWeaviateExposeGRPCPort bool withSecondWeaviate bool withWeaviateCluster bool withWeaviateClusterSize int withWeaviateAuth bool withWeaviateBasicAuth bool withWeaviateBasicAuthUsername string withWeaviateBasicAuthPassword string withWeaviateApiKey bool weaviateApiKeyUsers []ApiKeyUser weaviateAdminlistAdminUsers []string weaviateAdminlistReadOnlyUsers []string withWeaviateDbUsers bool withWeaviateRbac bool weaviateRbacRoots []string weaviateRbacRootGroups []string weaviateRbacViewerGroups []string weaviateRbacViewers []string withSUMTransformers bool withCentroid bool withCLIP bool withGoogleApiKey string withBind bool withImg2Vec bool withRerankerTransformers bool withOllamaVectorizer bool withOllamaGenerative bool withAutoschema bool withMockOIDC bool withMockOIDCWithCertificate bool weaviateEnvs map[string]string removeEnvs map[string]struct{} } func New() *Compose { return &Compose{enableModules: []string{}, weaviateEnvs: make(map[string]string), removeEnvs: make(map[string]struct{}), withBackendS3Buckets: make(map[string]string)} } func (d *Compose) WithGCS() *Compose { d.withGCS = true d.enableModules = append(d.enableModules, modstggcs.Name) return d } func (d *Compose) WithAzurite() *Compose { d.withAzurite = true d.enableModules = append(d.enableModules, modstgazure.Name) return d } func (d *Compose) WithText2VecTransformers() *Compose { d.withTransformers = true d.enableModules = append(d.enableModules, Text2VecTransformers) d.defaultVectorizerModule = Text2VecTransformers return d } func (d *Compose) WithText2VecTransformersImage(image string) *Compose { d.withTransformers = true d.withTransformersImage = image d.enableModules = append(d.enableModules, Text2VecTransformers) d.defaultVectorizerModule = Text2VecTransformers return d } func (d *Compose) WithText2VecContextionary() *Compose { d.withContextionary = true d.enableModules = append(d.enableModules, Text2VecContextionary) d.defaultVectorizerModule = Text2VecContextionary return d } func (d *Compose) WithText2VecOllama() *Compose { d.withOllamaVectorizer = true d.enableModules = append(d.enableModules, modollama.Name) return d } func (d *Compose) WithQnATransformers() *Compose { d.withQnATransformers = true d.enableModules = append(d.enableModules, QnATransformers) return d } func (d *Compose) WithBackendFilesystem() *Compose { d.withBackendFilesystem = true d.enableModules = append(d.enableModules, modstgfilesystem.Name) return d } // WithBackendS3 will prepare MinIO func (d *Compose) WithBackendS3(bucket, region string) *Compose { d.withBackendS3 = true d.withBackupS3Bucket = bucket d.withBackendS3Buckets[bucket] = region d.withMinIO = true d.enableModules = append(d.enableModules, modstgs3.Name) return d } // WithOffloadS3 will prepare MinIO func (d *Compose) WithOffloadS3(bucket, region string) *Compose { d.withBackendS3 = true d.withOffloadS3Bucket = bucket d.withBackendS3Buckets[bucket] = region d.withMinIO = true d.enableModules = append(d.enableModules, modsloads3.Name) return d } func (d *Compose) WithBackendGCS(bucket string) *Compose { d.withBackendGCS = true d.withBackendGCSBucket = bucket d.withGCS = true d.enableModules = append(d.enableModules, modstggcs.Name) return d } func (d *Compose) WithBackendAzure(container string) *Compose { d.withBackendAzure = true d.withBackendAzureContainer = container d.withAzurite = true d.enableModules = append(d.enableModules, modstgazure.Name) return d } func (d *Compose) WithSUMTransformers() *Compose { d.withSUMTransformers = true d.enableModules = append(d.enableModules, SUMTransformers) return d } func (d *Compose) WithMulti2VecCLIP() *Compose { d.withCLIP = true d.enableModules = append(d.enableModules, Multi2VecCLIP) return d } func (d *Compose) WithMulti2VecGoogle(apiKey string) *Compose { d.withGoogleApiKey = apiKey d.enableModules = append(d.enableModules, modmulti2vecgoogle.Name) return d } func (d *Compose) WithMulti2VecCohere(apiKey string) *Compose { d.weaviateEnvs["COHERE_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modmulti2veccohere.Name) return d } func (d *Compose) WithMulti2VecNvidia(apiKey string) *Compose { d.weaviateEnvs["NVIDIA_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modmulti2vecnvidia.Name) return d } func (d *Compose) WithMulti2VecVoyageAI(apiKey string) *Compose { d.weaviateEnvs["VOYAGEAI_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modmulti2vecvoyageai.Name) return d } func (d *Compose) WithMulti2VecJinaAI(apiKey string) *Compose { d.weaviateEnvs["JINAAI_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modmulti2vecjinaai.Name) return d } func (d *Compose) WithMulti2MultivecJinaAI(apiKey string) *Compose { d.weaviateEnvs["JINAAI_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modmulti2multivecjinaai.Name) return d } func (d *Compose) WithMulti2VecBind() *Compose { d.withBind = true d.enableModules = append(d.enableModules, Multi2VecBind) return d } func (d *Compose) WithImg2VecNeural() *Compose { d.withImg2Vec = true d.enableModules = append(d.enableModules, Img2VecNeural) return d } func (d *Compose) WithRef2VecCentroid() *Compose { d.withCentroid = true d.enableModules = append(d.enableModules, Ref2VecCentroid) return d } func (d *Compose) WithText2VecOpenAI(openAIApiKey, openAIOrganization, azureApiKey string) *Compose { d.weaviateEnvs["OPENAI_APIKEY"] = openAIApiKey d.weaviateEnvs["OPENAI_ORGANIZATION"] = openAIOrganization d.weaviateEnvs["AZURE_APIKEY"] = azureApiKey d.enableModules = append(d.enableModules, modopenai.Name) return d } func (d *Compose) WithText2VecCohere(apiKey string) *Compose { d.weaviateEnvs["COHERE_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modcohere.Name) return d } func (d *Compose) WithText2VecVoyageAI(apiKey string) *Compose { d.weaviateEnvs["VOYAGEAI_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modvoyageai.Name) return d } func (d *Compose) WithText2VecGoogle(apiKey string) *Compose { d.withGoogleApiKey = apiKey d.enableModules = append(d.enableModules, modgoogle.Name) return d } func (d *Compose) WithText2VecAWS(accessKey, secretKey, sessionToken string) *Compose { d.weaviateEnvs["AWS_ACCESS_KEY"] = accessKey d.weaviateEnvs["AWS_SECRET_KEY"] = secretKey d.weaviateEnvs["AWS_SESSION_TOKEN"] = sessionToken d.enableModules = append(d.enableModules, modaws.Name) return d } func (d *Compose) WithText2VecHuggingFace(apiKey string) *Compose { d.weaviateEnvs["HUGGINGFACE_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modhuggingface.Name) return d } func (d *Compose) WithText2VecWeaviate() *Compose { d.enableModules = append(d.enableModules, modweaviateembed.Name) return d } func (d *Compose) WithGenerativeOpenAI(openAIApiKey, openAIOrganization, azureApiKey string) *Compose { d.weaviateEnvs["OPENAI_APIKEY"] = openAIApiKey d.weaviateEnvs["OPENAI_ORGANIZATION"] = openAIOrganization d.weaviateEnvs["AZURE_APIKEY"] = azureApiKey d.enableModules = append(d.enableModules, modgenerativeopenai.Name) return d } func (d *Compose) WithGenerativeNvidia(apiKey string) *Compose { d.weaviateEnvs["NVIDIA_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modgenerativenvidia.Name) return d } func (d *Compose) WithGenerativeXAI(apiKey string) *Compose { d.weaviateEnvs["XAI_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modgenerativexai.Name) return d } func (d *Compose) WithText2VecJinaAI(apiKey string) *Compose { d.weaviateEnvs["JINAAI_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modjinaai.Name) return d } func (d *Compose) WithText2MultivecJinaAI(apiKey string) *Compose { d.weaviateEnvs["JINAAI_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modtext2colbertjinaai.Name) return d } func (d *Compose) WithRerankerNvidia(apiKey string) *Compose { d.weaviateEnvs["NVIDIA_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modrerankernvidia.Name) return d } func (d *Compose) WithText2VecNvidia(apiKey string) *Compose { d.weaviateEnvs["NVIDIA_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modnvidia.Name) return d } func (d *Compose) WithText2VecModel2Vec() *Compose { d.withModel2Vec = true d.enableModules = append(d.enableModules, modmodel2vec.Name) return d } func (d *Compose) WithText2VecMistral(apiKey string) *Compose { d.weaviateEnvs["MISTRAL_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modmistral.Name) return d } func (d *Compose) WithGenerativeAWS(accessKey, secretKey, sessionToken string) *Compose { d.weaviateEnvs["AWS_ACCESS_KEY"] = accessKey d.weaviateEnvs["AWS_SECRET_KEY"] = secretKey d.weaviateEnvs["AWS_SESSION_TOKEN"] = sessionToken d.enableModules = append(d.enableModules, modgenerativeaws.Name) return d } func (d *Compose) WithGenerativeCohere(apiKey string) *Compose { d.weaviateEnvs["COHERE_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modgenerativecohere.Name) return d } func (d *Compose) WithGenerativeFriendliAI(apiKey string) *Compose { d.weaviateEnvs["FRIENDLI_TOKEN"] = apiKey d.enableModules = append(d.enableModules, modgenerativefriendliai.Name) return d } func (d *Compose) WithGenerativeGoogle(apiKey string) *Compose { d.withGoogleApiKey = apiKey d.enableModules = append(d.enableModules, modgenerativegoogle.Name) return d } func (d *Compose) WithGenerativeAnyscale() *Compose { d.enableModules = append(d.enableModules, modgenerativeanyscale.Name) return d } func (d *Compose) WithGenerativeOllama() *Compose { d.withOllamaGenerative = true d.enableModules = append(d.enableModules, modgenerativeollama.Name) return d } func (d *Compose) WithGenerativeAnthropic(apiKey string) *Compose { d.weaviateEnvs["ANTHROPIC_APIKEY"] = apiKey d.enableModules = append(d.enableModules, modgenerativeanthropic.Name) return d } func (d *Compose) WithQnAOpenAI() *Compose { d.enableModules = append(d.enableModules, modqnaopenai.Name) return d } func (d *Compose) WithRerankerCohere() *Compose { d.enableModules = append(d.enableModules, modrerankercohere.Name) return d } func (d *Compose) WithRerankerVoyageAI() *Compose { d.enableModules = append(d.enableModules, modrerankervoyageai.Name) return d } func (d *Compose) WithRerankerTransformers() *Compose { d.withRerankerTransformers = true d.enableModules = append(d.enableModules, RerankerTransformers) return d } func (d *Compose) WithOllamaVectorizer() *Compose { d.withOllamaVectorizer = true return d } func (d *Compose) WithOllamaGenerative() *Compose { d.withOllamaGenerative = true return d } func (d *Compose) WithWeaviate() *Compose { return d.With1NodeCluster() } func (d *Compose) WithWeaviateWithGRPC() *Compose { d.With1NodeCluster() d.withWeaviateExposeGRPCPort = true return d } func (d *Compose) WithWeaviateCluster(size int) *Compose { if size%2 == 0 { panic("it's essential for the cluster size to be an odd number to ensure a majority can be achieved for quorum decisions, even if some nodes become unavailable") } d.withWeaviateCluster = true d.withWeaviateClusterSize = size return d } func (d *Compose) WithWeaviateClusterWithGRPC() *Compose { d.With3NodeCluster() d.withWeaviateExposeGRPCPort = true return d } func (d *Compose) WithWeaviateBasicAuth(username, password string) *Compose { d.withWeaviateBasicAuth = true d.withWeaviateBasicAuthUsername = username d.withWeaviateBasicAuthPassword = password return d } func (d *Compose) WithWeaviateAuth() *Compose { d.withWeaviateAuth = true return d.With1NodeCluster() } func (d *Compose) WithAdminListAdmins(users ...string) *Compose { d.weaviateAdminlistAdminUsers = users return d } func (d *Compose) WithAdminListUsers(users ...string) *Compose { d.weaviateAdminlistReadOnlyUsers = users return d } func (d *Compose) WithWeaviateEnv(name, value string) *Compose { d.weaviateEnvs[name] = value return d } func (d *Compose) WithMockOIDC() *Compose { d.withMockOIDC = true return d } func (d *Compose) WithMockOIDCWithCertificate() *Compose { d.withMockOIDCWithCertificate = true return d } func (d *Compose) WithApiKey() *Compose { d.withWeaviateApiKey = true return d } func (d *Compose) WithUserApiKey(username, key string) *Compose { if !d.withWeaviateApiKey { panic("RBAC is not enabled. Chain .WithRBAC() first") } d.weaviateApiKeyUsers = append(d.weaviateApiKeyUsers, ApiKeyUser{ Username: username, Key: key, }) return d } func (d *Compose) WithRBAC() *Compose { d.withWeaviateRbac = true return d } func (d *Compose) WithDbUsers() *Compose { d.withWeaviateDbUsers = true return d } func (d *Compose) WithRbacRoots(usernames ...string) *Compose { if !d.withWeaviateRbac { panic("RBAC is not enabled. Chain .WithRBAC() first") } d.weaviateRbacRoots = append(d.weaviateRbacRoots, usernames...) return d } func (d *Compose) WithRbacRootGroups(groups ...string) *Compose { if !d.withWeaviateRbac { panic("RBAC is not enabled. Chain .WithRBAC() first") } d.weaviateRbacRootGroups = append(d.weaviateRbacRootGroups, groups...) return d } func (d *Compose) WithRbacViewerGroups(groups ...string) *Compose { if !d.withWeaviateRbac { panic("RBAC is not enabled. Chain .WithRBAC() first") } d.weaviateRbacViewerGroups = append(d.weaviateRbacViewerGroups, groups...) return d } func (d *Compose) WithRbacViewers(usernames ...string) *Compose { if !d.withWeaviateRbac { panic("RBAC is not enabled. Chain .WithRBAC() first") } d.weaviateRbacViewers = append(d.weaviateRbacViewers, usernames...) return d } func (d *Compose) WithoutWeaviateEnvs(names ...string) *Compose { for _, name := range names { d.removeEnvs[name] = struct{}{} } return d } func (d *Compose) WithAutoschema() *Compose { d.withAutoschema = true return d } func (d *Compose) Start(ctx context.Context) (*DockerCompose, error) { d.weaviateEnvs["DISABLE_TELEMETRY"] = "true" network, err := tescontainersnetwork.New( ctx, tescontainersnetwork.WithAttachable(), ) if err != nil { return nil, errors.Wrapf(err, "connecting to network") } networkName := network.Name envSettings := make(map[string]string) envSettings["network"] = networkName envSettings["DISABLE_TELEMETRY"] = "true" containers := []*DockerContainer{} if d.withMinIO { container, err := startMinIO(ctx, networkName, d.withBackendS3Buckets) if err != nil { return nil, errors.Wrapf(err, "start %s", MinIO) } containers = append(containers, container) if d.withBackendS3 { if d.withBackupS3Bucket != "" { envSettings["BACKUP_S3_BUCKET"] = d.withBackupS3Bucket } if d.withOffloadS3Bucket != "" { envSettings["OFFLOAD_S3_BUCKET"] = d.withOffloadS3Bucket envSettings["OFFLOAD_S3_BUCKET_AUTO_CREATE"] = "true" } for k, v := range container.envSettings { envSettings[k] = v } } } if d.withGCS { container, err := startGCS(ctx, networkName) if err != nil { return nil, errors.Wrapf(err, "start %s", GCS) } containers = append(containers, container) if d.withBackendGCS { for k, v := range container.envSettings { envSettings[k] = v } envSettings["BACKUP_GCS_BUCKET"] = d.withBackendGCSBucket } } if d.withAzurite { container, err := startAzurite(ctx, networkName) if err != nil { return nil, errors.Wrapf(err, "start %s", Azurite) } containers = append(containers, container) if d.withBackendAzure { for k, v := range container.envSettings { envSettings[k] = v } envSettings["BACKUP_AZURE_CONTAINER"] = d.withBackendAzureContainer } } if d.withBackendFilesystem { envSettings["BACKUP_FILESYSTEM_PATH"] = "/tmp/backups" } if d.withModel2Vec { image := os.Getenv(envTestText2vecModel2VecImage) container, err := startT2VModel2Vec(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", Text2VecModel2Vec) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withTransformers { image := os.Getenv(envTestText2vecTransformersImage) if d.withTransformersImage != "" { image = d.withTransformersImage } container, err := startT2VTransformers(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", Text2VecTransformers) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withContextionary { image := os.Getenv(envTestText2vecContextionaryImage) container, err := startT2VContextionary(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", Text2VecContextionary) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withOllamaVectorizer { container, err := startOllamaVectorizer(ctx, networkName) if err != nil { return nil, errors.Wrapf(err, "start %s", OllamaVectorizer) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withOllamaGenerative { container, err := startOllamaGenerative(ctx, networkName) if err != nil { return nil, errors.Wrapf(err, "start %s", OllamaGenerative) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withQnATransformers { image := os.Getenv(envTestQnATransformersImage) container, err := startQnATransformers(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", QnATransformers) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withSUMTransformers { image := os.Getenv(envTestSUMTransformersImage) container, err := startSUMTransformers(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", SUMTransformers) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withCLIP { image := os.Getenv(envTestMulti2VecCLIPImage) container, err := startM2VClip(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", Multi2VecCLIP) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withGoogleApiKey != "" { envSettings["GOOGLE_APIKEY"] = d.withGoogleApiKey } if d.withBind { image := os.Getenv(envTestMulti2VecBindImage) container, err := startM2VBind(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", Multi2VecBind) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withImg2Vec { image := os.Getenv(envTestImg2VecNeuralImage) container, err := startI2VNeural(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", Img2VecNeural) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withRerankerTransformers { image := os.Getenv(envTestRerankerTransformersImage) container, err := startRerankerTransformers(ctx, networkName, image) if err != nil { return nil, errors.Wrapf(err, "start %s", RerankerTransformers) } for k, v := range container.envSettings { envSettings[k] = v } containers = append(containers, container) } if d.withMockOIDC || d.withMockOIDCWithCertificate { var certificate, certificateKey string if d.withMockOIDCWithCertificate { // Generate certifcate and certificate's private key certificate, certificateKey, err = GenerateCertificateAndKey(MockOIDC) if err != nil { return nil, errors.Wrapf(err, "cannot generate mock certificates for %s", MockOIDC) } } image := os.Getenv(envTestMockOIDCImage) container, err := startMockOIDC(ctx, networkName, image, certificate, certificateKey) if err != nil { return nil, errors.Wrapf(err, "start %s", MockOIDC) } for k, v := range container.envSettings { if k == "AUTHENTICATION_OIDC_CERTIFICATE" && envSettings[k] != "" { // allow to pass some other certificate using WithWeaviateEnv method continue } envSettings[k] = v } containers = append(containers, container) helperImage := os.Getenv(envTestMockOIDCHelperImage) helperContainer, err := startMockOIDCHelper(ctx, networkName, helperImage, certificate) if err != nil { return nil, errors.Wrapf(err, "start %s", MockOIDCHelper) } containers = append(containers, helperContainer) } if d.withWeaviateCluster { cs, err := d.startCluster(ctx, d.withWeaviateClusterSize, envSettings) for _, c := range cs { if c != nil { containers = append(containers, c) } } return &DockerCompose{network, containers}, err } if d.withSecondWeaviate { image := os.Getenv(envTestWeaviateImage) hostname := SecondWeaviate secondWeaviateSettings := envSettings // Ensure second weaviate doesn't get cluster settings from the first cluster if any. delete(secondWeaviateSettings, "CLUSTER_HOSTNAME") delete(secondWeaviateSettings, "CLUSTER_GOSSIP_BIND_PORT") delete(secondWeaviateSettings, "CLUSTER_DATA_BIND_PORT") delete(secondWeaviateSettings, "CLUSTER_JOIN") for k, v := range d.weaviateEnvs { envSettings[k] = v } delete(secondWeaviateSettings, "RAFT_PORT") delete(secondWeaviateSettings, "RAFT_INTERNAL_PORT") delete(secondWeaviateSettings, "RAFT_JOIN") container, err := startWeaviate(ctx, d.enableModules, d.defaultVectorizerModule, envSettings, networkName, image, hostname, d.withWeaviateExposeGRPCPort, "/v1/.well-known/ready") if err != nil { return nil, errors.Wrapf(err, "start %s", hostname) } containers = append(containers, container) if err != nil { return &DockerCompose{network, containers}, errors.Wrapf(err, "start %s", hostname) } } return &DockerCompose{network, containers}, nil } func (d *Compose) With1NodeCluster() *Compose { d.withWeaviateCluster = true d.withWeaviateClusterSize = 1 return d } func (d *Compose) With3NodeCluster() *Compose { d.withWeaviateCluster = true d.withWeaviateClusterSize = 3 return d } func (d *Compose) startCluster(ctx context.Context, size int, settings map[string]string) ([]*DockerContainer, error) { if size == 0 || size > 3 { return nil, nil } for k, v := range d.weaviateEnvs { settings[k] = v } for k := range d.removeEnvs { delete(settings, k) } raft_join := "node1,node2,node3" if size == 1 { raft_join = "node1" } else if size == 2 { raft_join = "node1,node2" } cs := make([]*DockerContainer, size) image := os.Getenv(envTestWeaviateImage) networkName := settings["network"] settings["DISABLE_TELEMETRY"] = "true" if d.withWeaviateBasicAuth { settings["CLUSTER_BASIC_AUTH_USERNAME"] = d.withWeaviateBasicAuthUsername settings["CLUSTER_BASIC_AUTH_PASSWORD"] = d.withWeaviateBasicAuthPassword } if d.withWeaviateAuth { settings["AUTHENTICATION_OIDC_ENABLED"] = "true" settings["AUTHENTICATION_OIDC_CLIENT_ID"] = "wcs" settings["AUTHENTICATION_OIDC_ISSUER"] = "https://auth.wcs.api.weaviate.io/auth/realms/SeMI" settings["AUTHENTICATION_OIDC_USERNAME_CLAIM"] = "email" settings["AUTHENTICATION_OIDC_GROUPS_CLAIM"] = "groups" settings["AUTHORIZATION_ADMINLIST_ENABLED"] = "true" settings["AUTHORIZATION_ADMINLIST_USERS"] = "oidc-test-user@weaviate.io" } if len(d.weaviateAdminlistAdminUsers) > 0 { settings["AUTHORIZATION_ADMINLIST_ENABLED"] = "true" settings["AUTHORIZATION_ADMINLIST_USERS"] = strings.Join(d.weaviateAdminlistAdminUsers, ",") if len(d.weaviateAdminlistReadOnlyUsers) > 0 { settings["AUTHORIZATION_ADMINLIST_READONLY_USERS"] = strings.Join(d.weaviateAdminlistReadOnlyUsers, ",") } } if d.withWeaviateApiKey { usernames := make([]string, 0, len(d.weaviateApiKeyUsers)) keys := make([]string, 0, len(d.weaviateApiKeyUsers)) for _, user := range d.weaviateApiKeyUsers { usernames = append(usernames, user.Username) keys = append(keys, user.Key) } if len(keys) > 0 { settings["AUTHENTICATION_APIKEY_ALLOWED_KEYS"] = strings.Join(keys, ",") settings["AUTHENTICATION_APIKEY_ENABLED"] = "true" } if len(usernames) > 0 { settings["AUTHENTICATION_APIKEY_USERS"] = strings.Join(usernames, ",") settings["AUTHENTICATION_APIKEY_ENABLED"] = "true" } } if d.withWeaviateRbac { settings["AUTHORIZATION_RBAC_ENABLED"] = "true" settings["AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED"] = "false" // incompatible if len(d.weaviateRbacRoots) > 0 { settings["AUTHORIZATION_RBAC_ROOT_USERS"] = strings.Join(d.weaviateRbacRoots, ",") } if len(d.weaviateRbacViewers) > 0 { settings["AUTHORIZATION_VIEWER_USERS"] = strings.Join(d.weaviateRbacViewers, ",") } if len(d.weaviateRbacRootGroups) > 0 { settings["AUTHORIZATION_RBAC_ROOT_GROUPS"] = strings.Join(d.weaviateRbacRootGroups, ",") } if len(d.weaviateRbacViewerGroups) > 0 { settings["AUTHORIZATION_RBAC_READONLY_GROUPS"] = strings.Join(d.weaviateRbacViewerGroups, ",") } } if d.withWeaviateDbUsers { settings["AUTHENTICATION_DB_USERS_ENABLED"] = "true" } if d.withAutoschema { settings["AUTOSCHEMA_ENABLED"] = "true" } settings["RAFT_PORT"] = "8300" settings["RAFT_INTERNAL_RPC_PORT"] = "8301" settings["RAFT_JOIN"] = raft_join settings["RAFT_BOOTSTRAP_EXPECT"] = strconv.Itoa(d.withWeaviateClusterSize) // first node config1 := copySettings(settings) config1["CLUSTER_HOSTNAME"] = "node1" config1["CLUSTER_GOSSIP_BIND_PORT"] = "7100" config1["CLUSTER_DATA_BIND_PORT"] = "7101" eg := errgroup.Group{} wellKnownEndpointFunc := func(hostname string) string { if slices.Contains(strings.Split(settings["MAINTENANCE_NODES"], ","), hostname) { return "/v1/.well-known/live" } return "/v1/.well-known/ready" } eg.Go(func() (err error) { cs[0], err = startWeaviate(ctx, d.enableModules, d.defaultVectorizerModule, config1, networkName, image, Weaviate1, d.withWeaviateExposeGRPCPort, wellKnownEndpointFunc("node1")) if err != nil { return errors.Wrapf(err, "start %s", Weaviate1) } return nil }) if size > 1 { config2 := copySettings(settings) config2["CLUSTER_HOSTNAME"] = "node2" config2["CLUSTER_GOSSIP_BIND_PORT"] = "7102" config2["CLUSTER_DATA_BIND_PORT"] = "7103" config2["CLUSTER_JOIN"] = fmt.Sprintf("%s:7100", Weaviate1) eg.Go(func() (err error) { time.Sleep(time.Second * 10) // node1 needs to be up before we can start this node cs[1], err = startWeaviate(ctx, d.enableModules, d.defaultVectorizerModule, config2, networkName, image, Weaviate2, d.withWeaviateExposeGRPCPort, wellKnownEndpointFunc("node2")) if err != nil { return errors.Wrapf(err, "start %s", Weaviate2) } return nil }) } if size > 2 { config3 := copySettings(settings) config3["CLUSTER_HOSTNAME"] = "node3" config3["CLUSTER_GOSSIP_BIND_PORT"] = "7104" config3["CLUSTER_DATA_BIND_PORT"] = "7105" config3["CLUSTER_JOIN"] = fmt.Sprintf("%s:7100", Weaviate1) eg.Go(func() (err error) { time.Sleep(time.Second * 10) // node1 needs to be up before we can start this node cs[2], err = startWeaviate(ctx, d.enableModules, d.defaultVectorizerModule, config3, networkName, image, Weaviate3, d.withWeaviateExposeGRPCPort, wellKnownEndpointFunc("node3")) if err != nil { return errors.Wrapf(err, "start %s", Weaviate3) } return nil }) } return cs, eg.Wait() } func copySettings(s map[string]string) map[string]string { copy := make(map[string]string, len(s)) for k, v := range s { copy[k] = v } return copy }