### Run Setup Script Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/debezium-otel-tracing/README.md Executes a setup script to prepare the environment for the example. This script may perform initial configurations or checks. ```bash ./scripts/setup.sh ``` -------------------------------- ### Install Dependencies and Run Locally Source: https://github.com/apicurio/apicurio-registry/blob/main/ui/ui-editors/README.md Install project dependencies and start the development server for local testing. Access the application via http://localhost:9011/?demo. ```bash $ npm install $ npm run dev ``` -------------------------------- ### Run Local Volume Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/gitops/README.md Starts the local volume GitOps example using Docker Compose. This is the simplest setup for trying out GitOps mode. ```bash cd examples/gitops docker compose up ``` -------------------------------- ### Install and Run UI Source: https://github.com/apicurio/apicurio-registry/blob/main/ui/tests/DOCKER-TESTING.md Installs npm dependencies and starts the UI development server. Ensure the UI is accessible at http://localhost:8888. ```bash cd ui/ui-app npm install npm run dev ``` -------------------------------- ### Run Example Application Locally Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-a2a-features.adoc Commands to clone the repository, start the example application using Docker Compose, and run the Java application. ```bash cd examples/a2a-real-world-integration docker-compose up -d mvn clean compile exec:java ``` -------------------------------- ### Start UI in Development Mode Source: https://github.com/apicurio/apicurio-registry/blob/main/README.md Installs UI dependencies, initializes development environment, and starts the UI on port 8888. Requires navigating to the ui and ui-app directories. ```bash cd ui npm install cd ui-app ./init-dev.sh npm run dev ``` -------------------------------- ### Demo: Running Apicurio Registry Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/kafka-order-processing/PRESENTATION.md A sequence of bash commands to set up and run an example application using Apicurio Registry. This includes starting Docker containers, building Java applications, and running producer and consumer services. ```bash # 1. Start infrastructure cd examples/kafka-order-processing docker-compose up -d # 2. Build applications mvn clean package # 3. Run producer (generates orders every 5 seconds) cd order-producer mvn quarkus:dev # 4. Run consumer (processes orders) cd order-consumer mvn quarkus:dev # 5. View schemas in UI open http://localhost:8888 ``` -------------------------------- ### Start PostgreSQL Server Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-installing-registry-docker.adoc Starts a PostgreSQL database server. This is a prerequisite for installing Apicurio Registry with SQL database storage. ```bash $ postgres -D /usr/local/pgsql/data ``` -------------------------------- ### Run Local Volume Staging Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/gitops/README.md Starts the local volume GitOps example for the 'staging' registry, which includes experimental schemas. This configuration uses an environment variable to specify the storage ID. ```bash APICURIO_POLLING_STORAGE_ID=staging docker compose up ``` -------------------------------- ### Run Multi-Repo HTTPS Pull Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/gitops/README.md Starts the GitOps example that aggregates schemas from two Git branches across different repositories using the GitOps sidecar. This setup simulates managing schemas from multiple teams. ```bash cd examples/gitops/multi-repo-pull-https docker compose up ``` -------------------------------- ### Run Pull SSH Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/gitops/README.md Starts the GitOps example that pulls from a private Git repository over SSH. Requires a pre-generated SSH deploy key and the repository URL to be configured. ```bash cd examples/gitops/pull-ssh APICURIO_GITOPS_REPO_URL=git@github.com:your-org/your-schemas.git docker compose up ``` -------------------------------- ### Run Push Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/gitops/README.md Starts the GitOps example where the sidecar runs an SSH server to accept direct Git push operations. This is useful for restricted networks or CI/CD pipelines. ```bash cd examples/gitops/push docker compose up ``` -------------------------------- ### Build Example Application Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/sdk/go-sdk/README.md Compile the Go example application. Requires Go version 1.23 or later. ```bash make build ``` -------------------------------- ### Apicurio Registry Deployment Example Output Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/docs/modules/ROOT/partials/proc-registry-quickstart-sr.adoc Example output from the `oc get deployment` command, showing the status of the Apicurio Registry deployment. The 'READY' column indicates the number of desired replicas versus the number of available replicas. ```bash NAME READY UP-TO-DATE AVAILABLE AGE example-apicurioregistry-sql-deployment 1/1 1 1 XmYs ``` -------------------------------- ### Start Kafka Infrastructure with Docker Compose Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/kafka-order-processing/README.md Starts Kafka, Zookeeper, Apicurio Registry, and the Registry UI using Docker Compose. Ensure you are in the example's directory. ```bash cd examples/kafka-order-processing docker-compose up -d ``` -------------------------------- ### Run Example Application Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/sdk/go-sdk/README.md Execute the built example application to interact with the running Apicurio Registry server. ```bash bin/example ``` -------------------------------- ### Install Apicurio Registry Go SDK Source: https://github.com/apicurio/apicurio-registry/blob/main/go-sdk/Readme.md Install the Apicurio Registry Go SDK using the go get command. Ensure you are using Go version 1.23 or higher. ```bash go get github.com/apicurio/apicurio-registry/go-sdk/v3 ``` -------------------------------- ### Run Pull HTTPS Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/gitops/README.md Starts the GitOps example that pulls from a public Git repository over HTTPS using a sidecar. The sidecar handles cloning and fetching updates. ```bash cd examples/gitops/pull-https docker compose up ``` -------------------------------- ### Run TLS Basic Auth Example with Maven Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/maven-plugin-tls-credentials/README.md Execute this Maven command to run the TLS basic authentication example for Apicurio Registry. This requires prior setup of a TLS-enabled registry instance and appropriate certificates. ```bash mvn generate-sources -Ptls-basic-auth ``` -------------------------------- ### Start Minikube Cluster Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/mtls-minikube/README.md Initiates the Minikube Kubernetes cluster. Ensure Minikube is installed and configured before running. ```bash minikube start ``` -------------------------------- ### Navigate to Event-Driven Architecture Examples Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/event-driven-architecture/README.md Change the directory to the event-driven architecture examples within the cloned repository. ```bash cd examples/event-driven-architecture ``` -------------------------------- ### Start Docker Compose Infrastructure Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/debezium-otel-tracing/README.md Starts the necessary services for the example using Docker Compose. This command builds images if needed and runs containers in detached mode. ```bash docker compose up -d --build ``` -------------------------------- ### Start Apicurio Registry with Keycloak Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/docker-compose/README.md This command starts the complete Apicurio Registry stack integrated with Keycloak. This setup is for development and does not support SSL. ```bash docker compose -f docker-compose.apicurio.yml up ``` -------------------------------- ### Example Application Output Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/sdk/go-sdk/README.md Sample output from the example application, showing server details and artifact creation. ```text Server name: Apicurio Registry (SQL) Server version: 3.0.6 Created version 1 of artifact e98c1564-06a9-47fb-b551-ec4ec0cdf235 ``` -------------------------------- ### Apply Example CR Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/controller/src/test/resources/k8s/examples/gitops/README.md Command to apply a GitOps example custom resource to your Kubernetes cluster. ```bash kubectl apply -f example-pull-https.yaml ``` -------------------------------- ### Build and Start Registry from Source Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/odcs-data-contracts/README.md Commands to build the project from source and start the registry and UI. This involves Maven for the backend and npm for the frontend. ```bash # Build ./mvnw clean install -DskipTests # Start registry cd app/ && ../mvnw quarkus:dev # Start UI (separate terminal) cd ui && npm install && cd ui-app && npm run dev # UI at http://localhost:8888 ``` -------------------------------- ### Start Apicurio Registry with Observability Stack Source: https://github.com/apicurio/apicurio-registry/blob/main/distro/docker-compose/in-memory-with-observability/README.md Launches the Docker Compose setup for Apicurio Registry and its observability components. ```bash docker-compose up -d ``` -------------------------------- ### Install Apicurio Registry CLI from Build Output (Linux) Source: https://github.com/apicurio/apicurio-registry/blob/main/cli/README.md Installs the Apicurio Registry CLI on Linux after building it. This involves unzipping the output, running the install script, and sourcing the bashrc file. ```bash # On Linux (bash): unzip cli/target/apicurio-registry-cli-*.zip -d cli/target/cli && (pushd cli/target/cli && ./acr install ; popd) && source ~/.bashrc ``` -------------------------------- ### Install Apicurio Registry CLI Executable Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-managing-registry-artifacts-cli.adoc Installs the CLI executable to $HOME/bin, creates a configuration directory, and updates shell configuration files. Reload your shell configuration after installation. ```bash $ cd ~/apicurio-cli $ ./acr install ``` -------------------------------- ### Install Development Dependencies Source: https://github.com/apicurio/apicurio-registry/blob/main/ui/ui-app/README.md Run this command to install the necessary development and build dependencies for the project. Ensure Node.js version 16.x.x and npm version > 8.3.x are installed prior to execution. ```bash npm install ``` -------------------------------- ### Deploy Test Data and Local Volume Example Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/controller/src/test/resources/k8s/examples/gitops/README.md Commands to deploy the test data ConfigMap and the local volume example custom resource. ```bash kubectl apply -f gitops-test-data.configmap.yaml kubectl apply -f example-local-volume.yaml ``` -------------------------------- ### Install Dex using Helm Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-configuring-registry-security.adoc Install the Dex identity service using Helm. Ensure you have a `dex-values.yaml` file for custom configurations. ```bash helm install dex dex/dex -n dex -f dex-values.yaml ``` -------------------------------- ### Application Container Configuration Example Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-migrating-registry-v2-v3.adoc Example properties file for configuring the Apicurio Registry application container, affecting UI settings. ```properties # Example application container configuration: apicurio.ui.contextPath=/ apicurio.ui.navPrefixPath=/ apicurio.ui.docsUrl=/docs/ apicurio.ui.editorsUrl=/editors/ apicurio.ui.auth.oidc.redirect-uri=/ apicurio.ui.auth.oidc.client-id=apicurio-registry-ui apicurio.ui.auth.oidc.logout-url=f5 apicurio.ui.auth.oidc.scope=openid profile email apicurio.ui.features.read-only.enabled=false apicurio.ui.features.breadcrumbs=true apicurio.ui.features.settings=true ``` -------------------------------- ### Example Apicurio Registry Route URL Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/docs/modules/ROOT/partials/proc-registry-quickstart-sr.adoc An example of the URL output from the `oc get routes` command, which provides the address to access the Apicurio Registry web console. ```bash example-apicurioregistry-sql.apicurio-registry.router-default.apps.mycluster.myorg.mycompany.com ``` -------------------------------- ### Start Development Server Source: https://github.com/apicurio/apicurio-registry/blob/main/ui/ui-app/README.md Starts the development server, making the UI accessible at http://localhost:8888. A running registry backend is required for the UI to function correctly. ```bash npm run dev ``` -------------------------------- ### Install Apicurio Registry Operator from Published Version Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/README.md Installs the Apicurio Registry Operator using a released version. It fetches the installation YAML, replaces a placeholder namespace, and applies it to the cluster. It also applies an example Apicurio Registry CR. ```shell curl -sSL "https://raw.githubusercontent.com/Apicurio/apicurio-registry/$VERSION/operator/install/install.yaml" | sed "s/PLACEHOLDER_NAMESPACE/$NAMESPACE/g" | kubectl -n $NAMESPACE apply -f - kubectl -n $NAMESPACE apply -f controller/src/main/deploy/examples/simple.apicurioregistry3.yaml ``` -------------------------------- ### Run Kafka Order Processing Example Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/kafka-order-processing/PRESENTATION.md Clone the Apicurio Registry repository, navigate to the Kafka order processing example, and set up the environment using Docker Compose and Maven. Follow the README for further instructions. ```bash git clone https://github.com/Apicurio/apicurio-registry cd apicurio-registry/examples/kafka-order-processing docker-compose up -d mvn clean package # Follow README.md for next steps ``` -------------------------------- ### Build and Run Java Client Demo Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/mtls-minikube/README.md Navigates to the client directory, cleans the project, compiles the code, and executes the Java client demo using Maven. The client connects to the registry using mTLS, performs operations, and verifies connectivity. ```bash cd client mvn clean compile exec:java ``` -------------------------------- ### Example PostgreSQL HA with CloudNativePG Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-registry-high-availability.adoc Define a PostgreSQL cluster using the CloudNativePG operator for high availability. This example shows a 3-instance setup with specified storage and PostgreSQL parameters. ```yaml apiVersion: postgresql.cnpg.io/v1 kind: Cluster metadata: name: registry-db-cluster spec: instances: 3 storage: size: 20Gi storageClass: standard postgresql: parameters: max_connections: "200" backup: barmanObjectStore: # Configure backup storage ``` -------------------------------- ### Instantiate ContextualStep with Registry References Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/a2a-real-world-integration/README.md Example of creating a `ContextualStep` instance, specifying agent details, task template, and URNs for prompt and output schema artifacts from the registry. ```java new ContextualStep( "Analyze sentiment", "http://localhost:9001", "sentiment", "{{original}}" ) .withPromptTemplate("urn:apicurio:llm-agents.prompts/sentiment-agent-prompt") .withOutputSchema("urn:apicurio:llm-agents.schemas/sentiment-agent-output") ``` -------------------------------- ### Build and Run with Docker Source: https://github.com/apicurio/apicurio-registry/blob/main/ui/ui-editors/README.md Build a production-ready Docker image and run it. This involves installing dependencies, building the project, creating the Docker image, and then running the container, exposing port 8080. Access the application via http://localhost:8080/?demo. ```bash $ npm install $ npm run build $ docker build -t="apicurio/apicurio-studio-editors" --rm . $ docker run --rm -it -p 8080:8080 apicurio/apicurio-studio-editors ``` -------------------------------- ### Run Demo with Docker Compose Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/a2a-real-world-integration/README.md Execute the demo by starting services with Docker Compose. Ensure Ollama and Apicurio Registry are running. This command initiates the demo's backend services. ```bash # 1. Start Ollama and Apicurio Registry (requires ~4GB for llama3.2 model) cd examples/a2a-real-world-integration docker-compose up -d # 2. Wait for model download (first time only) docker-compose logs -f ollama-init # Wait for "Model llama3.2 is ready!" # 3. Run the demo mvn clean compile exec:java # 4. Open the Web UI open http://localhost:9000 # 5. View registered artifacts in Registry UI (optional) open http://localhost:8888 ``` -------------------------------- ### Example: Getting Contract Quality Score Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-data-contracts.adoc Demonstrates how to retrieve the quality score of a contract using a curl command. ```bash curl "http://localhost:8080/apis/registry/v3/groups/my-group/artifacts/my-artifact/contract/quality?contractId=orders-contract" ``` -------------------------------- ### Basic Command Line Usage Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/tips-for-creating-asciidoc-content.adoc Demonstrates a basic command for logging into a system. Use this for initial access. ```bash oc login -u admin -p admin ``` -------------------------------- ### Nginx v3 Configuration Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-migrating-registry-v2-v3.adoc Example nginx configuration for routing traffic to a v3 registry deployment. This setup enables read/write operations. ```nginx upstream registry { server registry-v3:8080; } server { location / { # All methods allowed proxy_pass http://registry; proxy_set_header Host $host; } } ``` -------------------------------- ### Run Fully Automated Confluent Export Test Source: https://github.com/apicurio/apicurio-registry/blob/main/utils/exportConfluent/src/test/README.md Execute the integration test that automatically starts both Confluent and Apicurio Registries using Testcontainers. This option handles all setup and cleanup. ```bash cd utils/exportConfluent mvn test -Dtest=ConfluentExportIT ``` -------------------------------- ### KafkaUser Configuration for SCRAM Authentication Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/docs/modules/ROOT/partials/proc-persistence-kafkasql-scram.adoc Define a KafkaUser resource with SCRAM-SHA-512 authentication and simple authorization. This example grants all permissions to topics, clusters, transactionalIds, and groups, suitable for initial setup. ```yaml apiVersion: kafka.strimzi.io/v1beta2 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster namespace: registry-example-kafkasql-scram spec: authentication: type: scram-sha-512 authorization: acls: - operation: All resource: name: '*' patternType: literal type: topic - operation: All resource: name: '*' patternType: literal type: cluster - operation: All resource: name: '*' patternType: literal type: transactionalId - operation: All resource: name: '*' patternType: literal type: group type: simple ``` -------------------------------- ### KafkaUser Configuration with TLS Authentication and ACLs Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/docs/modules/ROOT/partials/proc-persistence-kafkasql-tls.adoc Define a KafkaUser resource with TLS authentication and simple authorization. This example grants all operations on topics, clusters, transactionalIds, and groups, suitable for initial setup or administrative users. ```yaml apiVersion: kafka.strimzi.io/v1beta2 kind: KafkaUser metadata: name: my-user labels: strimzi.io/cluster: my-cluster namespace: registry-example-kafkasql-tls spec: authentication: type: tls authorization: acls: - operation: All resource: name: '*' patternType: literal type: topic - operation: All resource: name: '*' patternType: literal type: cluster - operation: All resource: name: '*' patternType: literal type: transactionalId - operation: All resource: name: '*' patternType: literal type: group type: simple ``` -------------------------------- ### Execute Documentation Script Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/rest-api/readme.adoc Run the provided shell script to start the documentation server. ```bash ./run.sh ``` -------------------------------- ### Example Docker Compose for Elasticsearch and Registry Source: https://github.com/apicurio/apicurio-registry/blob/main/app/src/main/java/io/apicurio/registry/storage/impl/search/README.md This Docker Compose setup demonstrates how to configure Elasticsearch and Apicurio Registry to work together for search indexing. Ensure experimental features and search indexing are enabled in the registry environment. ```yaml services: elasticsearch: image: docker.elastic.co/elasticsearch/elasticsearch:8.11.0 environment: - discovery.type=single-node - xpack.security.enabled=false ports: - "9200:9200" registry: image: quay.io/apicurio/apicurio-registry:latest environment: APICURIO_FEATURES_EXPERIMENTAL_ENABLED: "true" APICURIO_SEARCH_INDEX_ENABLED: "true" QUARKUS_ELASTICSEARCH_HOSTS: "elasticsearch:9200" ports: - "8080:8080" depends_on: - elasticsearch ``` -------------------------------- ### Import Kafkasql-Journal Topic Data Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/guide-exporting-registry-kafka-topic-data.adoc Clone the Apicurio Registry examples, build the kafkasql-topic-import tool, and then run it to import topic data. Ensure you have Java and Maven installed. Replace placeholders with your Kafka bootstrap server URL and the path to your topic dump file. ```bash git clone https://github.com/Apicurio/apicurio-registry.git cd examples/tools/kafkasql-topic-import mvn clean install export VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) java -jar target/apicurio-registry-tools-kafkasql-topic-import-$VERSION-jar-with-dependencies.jar -b -f ``` -------------------------------- ### Quickstart On-Cluster Operator Build Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/README.md Performs a quickstart for on-cluster development of the Apicurio Registry Operator, including building and preparing the operator image. ```shell make SKIP_TESTS=true quickstart ``` -------------------------------- ### Start Apicurio Registry Source: https://github.com/apicurio/apicurio-registry/blob/main/support-chat/README.md Starts a Docker container for Apicurio Registry. Ensure this is running before starting the support chat application. ```bash docker run -d --name apicurio-registry -p 8080:8080 quay.io/apicurio/apicurio-registry:3.2.0 ``` -------------------------------- ### Show Help for Test Script Source: https://github.com/apicurio/apicurio-registry/blob/main/ui/tests/DOCKER-TESTING.md Displays all available command-line options and usage instructions for the run-in-docker.sh script. ```bash ./run-in-docker.sh --help ``` -------------------------------- ### Install Project Dependencies with Poetry Source: https://github.com/apicurio/apicurio-registry/blob/main/python-sdk/README.md Install project dependencies using Poetry. Make sure Poetry is installed and available in your PATH. ```bash make install ``` -------------------------------- ### Show Test Script Help Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/http-caching/README.md Run this command to display the help message for the test script, showing available options and usage. ```bash ./setup-and-run-tests.sh --help ``` -------------------------------- ### Generate Remote Install File with Debugging Enabled Source: https://github.com/apicurio/apicurio-registry/blob/main/operator/README.md Generates the operator test install file with remote debugging enabled. The INSTALL_FILE variable specifies the output path for the install file. ```shell make INSTALL_FILE=controller/target/test-install.yaml DEBUG=true dist-install-file ``` -------------------------------- ### Build Applications with Maven Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/debezium-otel-tracing/README.md Builds all modules for the Debezium OTEL tracing example. Ensure you are in the correct directory before running. ```bash cd examples/debezium-otel-tracing # Build all modules (order-service, cdc-consumer, debezium-converter) mvn clean package -DskipTests ``` -------------------------------- ### Run MCP Server Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-llm-artifact-types-implementation.adoc Navigate to the 'mcp' directory and start the MCP Server using Maven. ```bash cd mcp ../mvnw quarkus:dev ``` -------------------------------- ### Install Apicurio Registry CLI from Build Output (macOS) Source: https://github.com/apicurio/apicurio-registry/blob/main/cli/README.md Installs the Apicurio Registry CLI on macOS after building it. This involves unzipping the output, running the install script, and sourcing the zshrc file. ```bash # On macOS (zsh): unzip cli/target/apicurio-registry-cli-*.zip -d cli/target/cli && (pushd cli/target/cli && ./acr install ; popd) && source ~/.zshrc ``` -------------------------------- ### Build Documentation Locally with Antora Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/readme.adoc Use this command to perform a local build of the documentation for testing purposes. Ensure Antora is installed first. ```bash $ antora local-test-playbook.yml ``` -------------------------------- ### Install Playwright Browsers Source: https://github.com/apicurio/apicurio-registry/blob/main/ui/README.md Installs the necessary browser binaries for Playwright to execute tests. ```bash npx playwright install ``` -------------------------------- ### UI Component Configuration Example Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-operator-config-reference.adoc Example of configuring the Apicurio Registry UI component, including enabling it, setting replicas, environment variables, and ingress host. ```yaml spec: ui: enabled: true replicas: 2 env: - name: REGISTRY_API_URL value: https://registry-api.example.com/apis/registry/v3 ingress: host: registry-ui.example.com ``` -------------------------------- ### Install Strimzi Operator Source: https://github.com/apicurio/apicurio-registry/blob/main/examples/otel-tracing/README.md Installs the Strimzi Operator in a Kubernetes cluster. Ensure you have kubectl configured. ```bash kubectl create namespace strimzi kubectl apply -f 'https://strimzi.io/install/latest?namespace=strimzi' -n strimzi ``` -------------------------------- ### Exchange Schema Example Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-managing-registry-artifacts-maven.adoc An example of an Avro schema artifact named 'Exchange' that can be referenced by other artifacts. ```json { "namespace": "com.kubetrade.schema.common", "type": "enum", "name": "Exchange", "symbols" : ["GEMINI"] } ``` -------------------------------- ### Verify Apicurio Registry CLI Installation Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-managing-registry-artifacts-cli.adoc Checks if the CLI was installed correctly by displaying the help message. ```bash $ acr --help ``` -------------------------------- ### Install Operator in Dedicated Namespace Source: https://github.com/apicurio/apicurio-registry/blob/main/docs/modules/ROOT/pages/getting-started/assembly-implementing-multitenancy.adoc Install the operator in a dedicated Kubernetes namespace. By default, it watches all namespaces. ```bash oc apply -f deploy/operator.yaml -n apicurio-operators ``` -------------------------------- ### Install Apicurio Registry CLI from Local ZIP Source: https://github.com/apicurio/apicurio-registry/blob/main/cli/README.md Installs the Apicurio Registry CLI from a local ZIP file. Replace `` with the actual path to the ZIP file. ```bash acr update --path ```