From 3f7372259a9acdd2d75b46d1808818c360eb3c9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20de=20la=20Pe=C3=B1a?= Date: Fri, 5 Jul 2024 10:27:41 +0200 Subject: [PATCH] docs: indicate version for the Run function (#2627) * docs: indicate version for the Run function * docs(cockroachdb): move info message to the right section * docs: proper info architecture --- docs/modules/artemis.md | 9 ++++++++- docs/modules/azurite.md | 9 ++++++++- docs/modules/cassandra.md | 9 ++++++++- docs/modules/chroma.md | 9 ++++++++- docs/modules/clickhouse.md | 9 ++++++++- docs/modules/cockroachdb.md | 15 +++++++++++---- docs/modules/consul.md | 9 ++++++++- docs/modules/couchbase.md | 7 +++++++ docs/modules/dolt.md | 9 ++++++++- docs/modules/elasticsearch.md | 9 ++++++++- docs/modules/gcloud.md | 24 ++++++++++++++++-------- docs/modules/inbucket.md | 9 ++++++++- docs/modules/influxdb.md | 7 +++++++ docs/modules/k3s.md | 10 ++++++++-- docs/modules/k6.md | 9 ++++++++- docs/modules/kafka.md | 9 ++++++++- docs/modules/localstack.md | 9 ++++++++- docs/modules/mariadb.md | 9 ++++++++- docs/modules/milvus.md | 9 ++++++++- docs/modules/minio.md | 9 ++++++++- docs/modules/mockserver.md | 9 ++++++++- docs/modules/mongodb.md | 9 ++++++++- docs/modules/mssql.md | 9 ++++++++- docs/modules/mysql.md | 7 +++++++ docs/modules/nats.md | 9 ++++++++- docs/modules/neo4j.md | 7 +++++++ docs/modules/ollama.md | 9 ++++++++- docs/modules/openfga.md | 9 ++++++++- docs/modules/openldap.md | 9 ++++++++- docs/modules/opensearch.md | 9 ++++++++- docs/modules/postgres.md | 9 ++++++++- docs/modules/pulsar.md | 7 +++++++ docs/modules/qdrant.md | 9 ++++++++- docs/modules/rabbitmq.md | 9 ++++++++- docs/modules/redis.md | 7 +++++++ docs/modules/redpanda.md | 9 ++++++++- docs/modules/registry.md | 9 ++++++++- docs/modules/surrealdb.md | 9 ++++++++- docs/modules/vault.md | 7 +++++++ docs/modules/vearch.md | 9 ++++++++- docs/modules/weaviate.md | 9 ++++++++- modulegen/_template/module.md.tmpl | 9 ++++++++- modulegen/main_test.go | 8 ++++---- 43 files changed, 344 insertions(+), 50 deletions(-) diff --git a/docs/modules/artemis.md b/docs/modules/artemis.md index 82aa87c659..dc6d370eea 100644 --- a/docs/modules/artemis.md +++ b/docs/modules/artemis.md @@ -24,7 +24,14 @@ go get github.com/testcontainers/testcontainers-go/modules/artemis [Connecting to an Artemis container](../../modules/artemis/examples_test.go) inside_block:connectToArtemisContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Artemis module exposes one entrypoint function to create the Artemis container, and this function receives three parameters: diff --git a/docs/modules/azurite.md b/docs/modules/azurite.md index cde6c4c88f..42440e34b3 100644 --- a/docs/modules/azurite.md +++ b/docs/modules/azurite.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/azurite [Creating a Azurite container](../../modules/azurite/examples_test.go) inside_block:runAzuriteContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Azurite module exposes one entrypoint function to create the Azurite container, and this function receives three parameters: diff --git a/docs/modules/cassandra.md b/docs/modules/cassandra.md index ee235a3098..66c8adc237 100644 --- a/docs/modules/cassandra.md +++ b/docs/modules/cassandra.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/cassandra [Creating a Cassandra container](../../modules/cassandra/examples_test.go) inside_block:runCassandraContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Cassandra module exposes one entrypoint function to create the Cassandra container, and this function receives three parameters: diff --git a/docs/modules/chroma.md b/docs/modules/chroma.md index 0a0ddf6de7..0b5efe44f8 100644 --- a/docs/modules/chroma.md +++ b/docs/modules/chroma.md @@ -25,7 +25,14 @@ go get github.com/testcontainers/testcontainers-go/modules/chroma [Creating a Chroma container](../../modules/chroma/examples_test.go) inside_block:runChromaContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Chroma module exposes one entrypoint function to create the Chroma container, and this function receives three parameters: diff --git a/docs/modules/clickhouse.md b/docs/modules/clickhouse.md index c6dba6e40e..f270d62651 100644 --- a/docs/modules/clickhouse.md +++ b/docs/modules/clickhouse.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/clickhouse [Test for a ClickHouse container](../../modules/clickhouse/examples_test.go) inside_block:runClickHouseContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The ClickHouse module exposes one entrypoint function to create the ClickHouse container, and this function receives three parameters: diff --git a/docs/modules/cockroachdb.md b/docs/modules/cockroachdb.md index 062b8302aa..b9211025c8 100644 --- a/docs/modules/cockroachdb.md +++ b/docs/modules/cockroachdb.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/cockroachdb [Creating a CockroachDB container](../../modules/cockroachdb/examples_test.go) inside_block:runCockroachDBContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The CockroachDB module exposes one entrypoint function to create the CockroachDB container, and this function receives three parameters: @@ -32,9 +39,6 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom - `string`, the Docker image to use. - `testcontainers.ContainerCustomizer`, a variadic argument for passing options. -!!!warning - When TLS is enabled there's a very small, unlikely chance that the underlying driver can panic when registering the driver as part of waiting for CockroachDB to be ready to accept connections. If this is repeatedly happening please open an issue. - ### Container Options When starting the CockroachDB container, you can pass options in a variadic way to configure it. @@ -65,6 +69,9 @@ Internally CockroachDB requires a client certificate for the user to connect wit A helper `cockroachdb.NewTLSConfig` exists to generate all of this for you. +!!!warning + When TLS is enabled there's a very small, unlikely chance that the underlying driver can panic when registering the driver as part of waiting for CockroachDB to be ready to accept connections. If this is repeatedly happening please open an issue. + ### Container Methods The CockroachDB container exposes the following methods: diff --git a/docs/modules/consul.md b/docs/modules/consul.md index 9cf026aed6..51787e2645 100644 --- a/docs/modules/consul.md +++ b/docs/modules/consul.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/consul [Creating a Consul container](../../modules/consul/examples_test.go) inside_block:runConsulContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Consul module exposes one entrypoint function to create the Consul container, and this function receives three parameters: diff --git a/docs/modules/couchbase.md b/docs/modules/couchbase.md index 8b7944a364..ccd389665e 100644 --- a/docs/modules/couchbase.md +++ b/docs/modules/couchbase.md @@ -22,6 +22,13 @@ go get github.com/testcontainers/testcontainers-go/modules/couchbase ## Module Reference +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. + The Couchbase module exposes one entrypoint function to create the Couchbase container, and this function receives three parameters: ```golang diff --git a/docs/modules/dolt.md b/docs/modules/dolt.md index 7c91bfe00d..71d1ee3357 100644 --- a/docs/modules/dolt.md +++ b/docs/modules/dolt.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/dolt [Creating a Dolt container](../../modules/dolt/examples_test.go) inside_block:runDoltContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Dolt module exposes one entrypoint function to create the Dolt container, and this function receives three parameters: diff --git a/docs/modules/elasticsearch.md b/docs/modules/elasticsearch.md index 52e7623f0c..4310879d02 100644 --- a/docs/modules/elasticsearch.md +++ b/docs/modules/elasticsearch.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/elasticsearch [Creating a Elasticsearch container](../../modules/elasticsearch/examples_test.go) inside_block:runElasticsearchContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Elasticsearch module exposes one entrypoint function to create the Elasticsearch container, and this function receives three parameters: diff --git a/docs/modules/gcloud.md b/docs/modules/gcloud.md index 0ebbba1372..e1089471aa 100644 --- a/docs/modules/gcloud.md +++ b/docs/modules/gcloud.md @@ -75,20 +75,28 @@ It's important to set the target string of the `grpc.Dial` method using the cont It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the Admin client example above. -## Module reference +## Module Reference -The GCloud module exposes one entrypoint function to create the different GCloud emulators, and each function receives two parameters: +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunXXXContainer(ctx, opts...)` functions are deprecated and will be removed in the next major release of _Testcontainers for Go_. + +The GCloud module exposes one entrypoint function to create the different GCloud emulators, and each function receives three parameters: ```golang -func RunBigQueryContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*BigQueryContainer, error) -func RunBigTableContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*BigTableContainer, error) -func RunDatastoreContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*DatastoreContainer, error) -func RunFirestoreContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*FirestoreContainer, error) -func RunPubsubContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*PubsubContainer, error) -func RunSpannerContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*SpannerContainer, error) +func RunBigQuery(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*BigQueryContainer, error) +func RunBigTable(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*BigTableContainer, error) +func RunDatastore(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DatastoreContainer, error) +func RunFirestore(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*FirestoreContainer, error) +func RunPubsub(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*PubsubContainer, error) +func RunSpanner(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*SpannerContainer, error) ``` - `context.Context`, the Go context. +- `string`, the Docker image to use. - `testcontainers.ContainerCustomizer`, a variadic argument for passing options. ### Container Options diff --git a/docs/modules/inbucket.md b/docs/modules/inbucket.md index ef29835ee7..8ee002e6a2 100644 --- a/docs/modules/inbucket.md +++ b/docs/modules/inbucket.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/inbucket [Creating a Inbucket container](../../modules/inbucket/examples_test.go) inside_block:runInbucketContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Inbucket module exposes one entrypoint function to create the Inbucket container, and this function receives three parameters: diff --git a/docs/modules/influxdb.md b/docs/modules/influxdb.md index 756af5de0f..62c49c0254 100644 --- a/docs/modules/influxdb.md +++ b/docs/modules/influxdb.md @@ -22,6 +22,13 @@ go get github.com/testcontainers/testcontainers-go/modules/influxdb ## Module Reference +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. + The InfluxDB module exposes one entrypoint function to create the container, and this function receives three parameters: ```golang diff --git a/docs/modules/k3s.md b/docs/modules/k3s.md index f1bb5517d6..20121ee216 100644 --- a/docs/modules/k3s.md +++ b/docs/modules/k3s.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/k3s [Test for a K3s container](../../modules/k3s/k3s_test.go) inside_block:runK3sContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The K3s module exposes one entrypoint function to create the K3s container, and this function receives three parameters: @@ -32,7 +39,6 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom - `string`, the Docker image to use. - `testcontainers.ContainerCustomizer`, a variadic argument for passing options. - ### Container Ports These are the ports used by the K3s container: diff --git a/docs/modules/k6.md b/docs/modules/k6.md index f5e721117b..c13e76f65f 100644 --- a/docs/modules/k6.md +++ b/docs/modules/k6.md @@ -27,7 +27,14 @@ go get github.com/testcontainers/testcontainers-go/modules/k6 [Creating a K6 container](../../modules/k6/examples_test.go) inside_block:runK6Container -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The K6 module exposes one entrypoint function to run the K6 container, and this function receives three parameters: diff --git a/docs/modules/kafka.md b/docs/modules/kafka.md index 71873f6ded..1dbc1aefff 100644 --- a/docs/modules/kafka.md +++ b/docs/modules/kafka.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/kafka [Creating a Kafka container](../../modules/kafka/examples_test.go) inside_block:runKafkaContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Kafka module exposes one entrypoint function to create the Kafka container, and this function receives three parameters: diff --git a/docs/modules/localstack.md b/docs/modules/localstack.md index 8182792f33..15b836693b 100644 --- a/docs/modules/localstack.md +++ b/docs/modules/localstack.md @@ -25,7 +25,14 @@ Running LocalStack as a stand-in for multiple AWS services during a test: Environment variables listed in [Localstack's README](https://github.com/localstack/localstack#configurations) may be used to customize Localstack's configuration. Use the `testcontainers.WithEnv` option when creating the `LocalStackContainer` to apply those variables. -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The LocalStack module exposes one single function to create the LocalStack container, and this function receives three parameters: diff --git a/docs/modules/mariadb.md b/docs/modules/mariadb.md index f487deb3d6..25323330f7 100644 --- a/docs/modules/mariadb.md +++ b/docs/modules/mariadb.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/mariadb [Creating a MariaDB container](../../modules/mariadb/examples_test.go) inside_block:runMariaDBContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The MariaDB module exposes one entrypoint function to create the MariaDB container, and this function receives three parameters: diff --git a/docs/modules/milvus.md b/docs/modules/milvus.md index 7c27391efa..2f395ae558 100644 --- a/docs/modules/milvus.md +++ b/docs/modules/milvus.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/milvus [Creating a Milvus container](../../modules/milvus/examples_test.go) inside_block:runMilvusContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Milvus module exposes one entrypoint function to create the Milvus container, and this function receives three parameters: diff --git a/docs/modules/minio.md b/docs/modules/minio.md index aac90e971b..45976cbba0 100644 --- a/docs/modules/minio.md +++ b/docs/modules/minio.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/minio [Creating a Minio container](../../modules/minio/examples_test.go) inside_block:runMinioContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Minio module exposes one entrypoint function to create the Minio container, and this function receives three parameters: diff --git a/docs/modules/mockserver.md b/docs/modules/mockserver.md index bff1e74140..4cf4686eb8 100644 --- a/docs/modules/mockserver.md +++ b/docs/modules/mockserver.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/mockserver [Creating a MockServer container](../../modules/mockserver/examples_test.go) inside_block:runMockServerContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The MockServer module exposes one entrypoint function to create the MockServer container, and this function receives three parameters: diff --git a/docs/modules/mongodb.md b/docs/modules/mongodb.md index 6fe7c0a748..f4893a4874 100644 --- a/docs/modules/mongodb.md +++ b/docs/modules/mongodb.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/mongodb [Creating a MongoDB container](../../modules/mongodb/examples_test.go) inside_block:runMongoDBContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The MongoDB module exposes one entrypoint function to create the MongoDB container, and this function receives three parameters: diff --git a/docs/modules/mssql.md b/docs/modules/mssql.md index 6debbe8a22..7aa69cd3f1 100644 --- a/docs/modules/mssql.md +++ b/docs/modules/mssql.md @@ -25,7 +25,14 @@ go get github.com/testcontainers/testcontainers-go/modules/mssql Please see the [`microsoft-mssql-server` image documentation](https://hub.docker.com/_/microsoft-mssql-server#environment-variables) for a link to the EULA document. -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The MS SQL Server module exposes one entrypoint function to create the MS SQL Server container, and this function receives three parameters: diff --git a/docs/modules/mysql.md b/docs/modules/mysql.md index 4c16030ec5..244b86df0f 100644 --- a/docs/modules/mysql.md +++ b/docs/modules/mysql.md @@ -22,6 +22,13 @@ go get github.com/testcontainers/testcontainers-go/modules/mysql ## Module Reference +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. + The MySQL module exposes one entrypoint function to create the container, and this function receives three parameters: ```golang diff --git a/docs/modules/nats.md b/docs/modules/nats.md index 82bb330ada..6ff0b1880c 100644 --- a/docs/modules/nats.md +++ b/docs/modules/nats.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/nats [Creating a NATS container](../../modules/nats/examples_test.go) inside_block:runNATSContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The NATS module exposes one entrypoint function to create the NATS container, and this function receives three parameters: diff --git a/docs/modules/neo4j.md b/docs/modules/neo4j.md index f00663b6c1..70bcb4cebe 100644 --- a/docs/modules/neo4j.md +++ b/docs/modules/neo4j.md @@ -24,6 +24,13 @@ Running Neo4j as a single-instance server, with the [APOC plugin](https://neo4j. ## Module Reference +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. + The Neo4j module exposes one entrypoint function to create the Neo4j container, and this function receives three parameters: ```golang diff --git a/docs/modules/ollama.md b/docs/modules/ollama.md index edae5d6a39..6bb9047172 100644 --- a/docs/modules/ollama.md +++ b/docs/modules/ollama.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/ollama [Creating a Ollama container](../../modules/ollama/examples_test.go) inside_block:runOllamaContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Ollama module exposes one entrypoint function to create the Ollama container, and this function receives three parameters: diff --git a/docs/modules/openfga.md b/docs/modules/openfga.md index 5fe839398b..472d8d60de 100644 --- a/docs/modules/openfga.md +++ b/docs/modules/openfga.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/openfga [Creating a OpenFGA container](../../modules/openfga/examples_test.go) inside_block:runOpenFGAContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The OpenFGA module exposes one entrypoint function to create the OpenFGA container, and this function receives three parameters: diff --git a/docs/modules/openldap.md b/docs/modules/openldap.md index 48e978bbc2..71a810295b 100644 --- a/docs/modules/openldap.md +++ b/docs/modules/openldap.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/openldap [Creating a OpenLDAP container](../../modules/openldap/examples_test.go) inside_block:runOpenLDAPContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The OpenLDAP module exposes one entrypoint function to create the OpenLDAP container, and this function receives three parameters: diff --git a/docs/modules/opensearch.md b/docs/modules/opensearch.md index 21d9073397..a6f78ab85d 100644 --- a/docs/modules/opensearch.md +++ b/docs/modules/opensearch.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/opensearch [Creating a OpenSearch container](../../modules/opensearch/examples_test.go) inside_block:runOpenSearchContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The OpenSearch module exposes one entrypoint function to create the OpenSearch container, and this function receives three parameters: diff --git a/docs/modules/postgres.md b/docs/modules/postgres.md index f052c2ad38..99ae97be08 100644 --- a/docs/modules/postgres.md +++ b/docs/modules/postgres.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/postgres [Creating a Postgres container](../../modules/postgres/examples_test.go) inside_block:runPostgresContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Postgres module exposes one entrypoint function to create the Postgres container, and this function receives three parameters: diff --git a/docs/modules/pulsar.md b/docs/modules/pulsar.md index 0831b385cd..7713e67f1e 100644 --- a/docs/modules/pulsar.md +++ b/docs/modules/pulsar.md @@ -28,6 +28,13 @@ Create a `Pulsar` container to use it in your tests: ## Module Reference +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. + The Pulsar module exposes one entrypoint function to create the containerr, and this function receives three parameters: ```golang diff --git a/docs/modules/qdrant.md b/docs/modules/qdrant.md index 4a499e247f..45c45c0afb 100644 --- a/docs/modules/qdrant.md +++ b/docs/modules/qdrant.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/qdrant [Creating a Qdrant container](../../modules/qdrant/examples_test.go) inside_block:runQdrantContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Qdrant module exposes one entrypoint function to create the Qdrant container, and this function receives three parameters: diff --git a/docs/modules/rabbitmq.md b/docs/modules/rabbitmq.md index 64a465f436..3fece430c1 100644 --- a/docs/modules/rabbitmq.md +++ b/docs/modules/rabbitmq.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/rabbitmq [Creating a RabbitMQ container](../../modules/rabbitmq/examples_test.go) inside_block:runRabbitMQContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The RabbitMQ module exposes one entrypoint function to create the RabbitMQ container, and this function receives three parameters: diff --git a/docs/modules/redis.md b/docs/modules/redis.md index 1b64b34fd7..aa2637e39b 100644 --- a/docs/modules/redis.md +++ b/docs/modules/redis.md @@ -22,6 +22,13 @@ go get github.com/testcontainers/testcontainers-go/modules/redis ## Module Reference +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. + The Redis module exposes one entrypoint function to create the containerr, and this function receives three parameters: ```golang diff --git a/docs/modules/redpanda.md b/docs/modules/redpanda.md index 01df7c4739..a9c024739a 100644 --- a/docs/modules/redpanda.md +++ b/docs/modules/redpanda.md @@ -25,7 +25,14 @@ go get github.com/testcontainers/testcontainers-go/modules/redpanda [Creating a Redpanda container](../../modules/redpanda/examples_test.go) inside_block:runRedpandaContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Redpanda module exposes one entrypoint function to create the Redpanda container, and this function receives three parameters: diff --git a/docs/modules/registry.md b/docs/modules/registry.md index 3e66d650ba..484c9425f4 100644 --- a/docs/modules/registry.md +++ b/docs/modules/registry.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/registry [Creating a Registry container](../../modules/registry/examples_test.go) inside_block:runRegistryContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Registry module exposes one entrypoint function to create the Registry container, and this function receives three parameters: diff --git a/docs/modules/surrealdb.md b/docs/modules/surrealdb.md index 9bf34ca05e..31a92b025f 100644 --- a/docs/modules/surrealdb.md +++ b/docs/modules/surrealdb.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/surrealdb [Creating a SurrealDB container](../../modules/surrealdb/examples_test.go) inside_block:runSurrealDBContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The SurrealDB module exposes one entrypoint function to create the SurrealDB container, and this function receives three parameters: diff --git a/docs/modules/vault.md b/docs/modules/vault.md index 8e9fd5e7a1..e7fbe1ca5d 100644 --- a/docs/modules/vault.md +++ b/docs/modules/vault.md @@ -48,6 +48,13 @@ go get -u github.com/hashicorp/vault-client-go ## Module Reference +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. + The Vault module exposes one entrypoint function to create the containerr, and this function receives three parameters: ```golang diff --git a/docs/modules/vearch.md b/docs/modules/vearch.md index 335f747060..f3ada2121c 100644 --- a/docs/modules/vearch.md +++ b/docs/modules/vearch.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/vearch [Creating a Vearch container](../../modules/vearch/examples_test.go) inside_block:runVearchContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Vearch module exposes one entrypoint function to create the Vearch container, and this function receives three parameters: diff --git a/docs/modules/weaviate.md b/docs/modules/weaviate.md index 9c7840200a..22f0c48507 100644 --- a/docs/modules/weaviate.md +++ b/docs/modules/weaviate.md @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/weaviate [Creating a Weaviate container](../../modules/weaviate/examples_test.go) inside_block:runWeaviateContainer -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The Weaviate module exposes one entrypoint function to create the Weaviate container, and this function receives three parameters: diff --git a/modulegen/_template/module.md.tmpl b/modulegen/_template/module.md.tmpl index d6320a852d..ac29fb3337 100644 --- a/modulegen/_template/module.md.tmpl +++ b/modulegen/_template/module.md.tmpl @@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/{{ ParentDir }}/{{ $lower }} [Creating a {{ $title }} container](../../{{ ParentDir }}/{{ $lower }}/examples_test.go) inside_block:run{{ $title }}Container -## Module reference +## Module Reference + +### Run function + +- Not available until the next release of testcontainers-go :material-tag: main + +!!!info + The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_. The {{ $title }} module exposes one entrypoint function to create the {{ $title }} container, and this function receives three parameters: diff --git a/modulegen/main_test.go b/modulegen/main_test.go index 2c7b29a2e5..2c1ddbd8e9 100644 --- a/modulegen/main_test.go +++ b/modulegen/main_test.go @@ -374,10 +374,10 @@ func assertModuleDocContent(t *testing.T, module context.TestcontainersModule, m assert.Equal(t, "", data[18]) assert.Equal(t, "[Creating a "+title+" container](../../"+module.ParentDir()+"/"+lower+"/examples_test.go) inside_block:run"+title+"Container", data[19]) assert.Equal(t, "", data[20]) - assert.Equal(t, "The "+title+" module exposes one entrypoint function to create the "+title+" container, and this function receives three parameters:", data[24]) - assert.True(t, strings.HasSuffix(data[27], "(*"+title+"Container, error)")) - assert.Equal(t, "If you need to set a different "+title+" Docker image, you can set a valid Docker image as the second argument in the `Run` function.", data[40]) - assert.Equal(t, "E.g. `Run(context.Background(), \""+module.Image+"\")`.", data[41]) + assert.Equal(t, "The "+title+" module exposes one entrypoint function to create the "+title+" container, and this function receives three parameters:", data[31]) + assert.True(t, strings.HasSuffix(data[34], "(*"+title+"Container, error)")) + assert.Equal(t, "If you need to set a different "+title+" Docker image, you can set a valid Docker image as the second argument in the `Run` function.", data[47]) + assert.Equal(t, "E.g. `Run(context.Background(), \""+module.Image+"\")`.", data[48]) } // assert content module test