Skip to content

Latest commit

 

History

History
101 lines (75 loc) · 3.67 KB

testing_and_validation.md

File metadata and controls

101 lines (75 loc) · 3.67 KB
Raw

Testing and validation

Run the whole setup

  1. Build the package you'd like to verify (e.g. apache):

    $ cd apache
$ elastic-package build

  2. Start testing environment:

    Run from inside the Integrations repository.

    $ elastic-package stack up -d -v

    The command above will boot up the Elastic stack (Elasticsearch, Kibana, Package Registry) using Docker containers. It rebuilds the Package Registry Docker image using packages built in step 1. and boots up the Package Registry.

    To reload the already deployed Package Registry use the following command:

    $ elastic-package stack up -v -d --services package-registry

  3. Verify that your integration is available (in the right version), e.g. MySQL: http://localhost:8080/search?package=mysql (use experimental=true parameter if the package is in experimental version. Alternatively set release to beta or higher in your package's manifest.yml, if appropriate.)

    [
  {
    "description": "MySQL Integration",
    "download": "/epr/mysql/mysql-0.0.1.tar.gz",
    "icons": [
      {
        "src": "/package/mysql/0.0.1/img/logo_mysql.svg",
        "title": "logo mysql",
        "size": "32x32",
        "type": "image/svg+xml"
      }
    ],
    "name": "mysql",
    "path": "/package/mysql/0.0.1",
    "title": "MySQL",
    "type": "integration",
    "version": "0.0.1"
  }
]

The elastic-package stack provides an enrolled instance of the Elastic Agent. Use that one instead of a local application if you can run the service (you're integrating with) in the Docker network and you don't need to rebuild the Elastic-Agent or it's subprocesses (e.g. Filebeat or Metricbeat). The service Docker image can be used for system testing. If you prefer to use a local instance of the Elastic Agent, proceed with steps 4 an 5:

  1. (Optional) Download the Elastic-Agent from https://www.elastic.co/downloads/elastic-agent

  2. (Optional) Enroll the agent and start it:

    Use the "Enroll new agent" option in the Kibana UI (Ingest Manager -> Fleet -> Create user and enable Fleet) and run a similar command:

    $ ./elastic-agent enroll http://localhost:5601/rel cFhNVlZIRUIxYjhmbFhqNTBoS2o6OUhMWkF4SFJRZmFNZTh3QmtvR1cxZw==
$ ./elastic-agent run

    The elastic-agent will start two other processes - metricbeat and filebeat.

  3. Run the product you're integrating with (e.g. a docker image with MySQL).

  4. Install package.

    Click out the configuration in the Kibana UI, deploy it and wait for the agent to pick out the updated configuration.

  5. Navigate with Kibana UI to freshly installed dashboards, verify the metrics/logs flow.

Use test runners

elastic-package provides different types of test runners. Review howto guides to learn about the various methods for testing packages.

The test subcommand requires a reference to the live Elastic stack. Service endpoints can be defined via environment variables. If you're using the Elastic stack created with elastic-package, you can use export endpoints with elastic-package stack shellinit:

$ eval "$(elastic-package stack shellinit)"

To preview environment variables:

$ elastic-package stack shellinit
export ELASTIC_PACKAGE_ELASTICSEARCH_HOST=http://127.0.0.1:9200
export ELASTIC_PACKAGE_ELASTICSEARCH_USERNAME=elastic
export ELASTIC_PACKAGE_ELASTICSEARCH_PASSWORD=changeme
export ELASTIC_PACKAGE_KIBANA_HOST=http://127.0.0.1:5601