Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/compose.yaml

393 lines
12 KiB
YAML
Raw Normal View History

docs: Add docker compose workflow for running docs locally (#5400) * docs: Add docker compose workflow for running docs locally * chore: Fixup compose.yaml for local build: - Added comments - Use the verbose mount syntax - Wrap /Users/ja/Documents/GitHub/docs-v2 in quotes for cross-platform compat. * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2024-04-01 17:17:07 +00:00
# This is a Docker Compose file for the InfluxData documentation site.
## Run documentation tests for code samples.
chore(ci): Improve CI lint and test runners - Reconfigures prettier linting. - Adds .editorconfig to help with consistent editor settings - Refactors test runs: - Removes test configuration from compose.yaml (not suited for this use case). - Splits test runner into test content setup and pytest that can be run separately or together (and with other test runners in the future). - Configuration is in Dockerfiles and command line (`.lintstagedrc.mjs`) - Updates CONTRIBUTING.md - Updates client library write examples in cloud-dedicated and clustered.
2024-06-21 23:41:07 +00:00
name: influxdata-docs
feat(v2): Use Docker Compose with secrets and `_FILE` env variables: - Add guide for installing v2 using Compose, secrets, and InfluxDB `_FILE` env variables. - Add project compose.yaml configuration for the same. - Content looks good in Hugo, but I'm getting an error from pytest that I haven't identified yet.
2024-07-30 15:00:14 +00:00
secrets:
influxdb2-admin-username:
file: ~/.env.influxdb2-admin-username
influxdb2-admin-password:
file: ~/.env.influxdb2-admin-password
influxdb2-admin-token:
file: ~/.env.influxdb2-admin-token
chore(qol): Test python and shell code samples. WIP - use for local testing only, not ready for CI. (#5154) - Adds a Docker image, scripts, and configuration that install and run pytest-codeblocks on Python and shell code samples in Markdown. - Copied from https://github.com/jstirnaman/docs-codeblocks/ - TODO: The script copies files into a tmp directory configured as a bind mount for the Docker container. We might want to replace this with the experimental `watch` feature. - TODO: Use a secret to configure the token. As is, values subbed from the dotenv file are exposed in your Docker container history.
2023-09-26 19:56:21 +00:00
services:
docs: Add docker compose workflow for running docs locally (#5400) * docs: Add docker compose workflow for running docs locally * chore: Fixup compose.yaml for local build: - Added comments - Use the verbose mount syntax - Wrap /Users/ja/Documents/GitHub/docs-v2 in quotes for cross-platform compat. * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2024-04-01 17:17:07 +00:00
local-dev:
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
build:
context: .
dockerfile_inline: |
FROM hugomods/hugo:exts-0.123.8
RUN apk add --no-cache curl openssl
docs: Add docker compose workflow for running docs locally (#5400) * docs: Add docker compose workflow for running docs locally * chore: Fixup compose.yaml for local build: - Added comments - Use the verbose mount syntax - Wrap /Users/ja/Documents/GitHub/docs-v2 in quotes for cross-platform compat. * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2024-04-01 17:17:07 +00:00
command: hugo server --bind 0.0.0.0
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:1313/influxdb/cloud-dedicated/"]
interval: 1m
timeout: 10s
retries: 2
start_period: 40s
start_interval: 5s
docs: Add docker compose workflow for running docs locally (#5400) * docs: Add docker compose workflow for running docs locally * chore: Fixup compose.yaml for local build: - Added comments - Use the verbose mount syntax - Wrap /Users/ja/Documents/GitHub/docs-v2 in quotes for cross-platform compat. * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> * docs: fixup readme style Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2024-04-01 17:17:07 +00:00
ports:
- 1313:1313
volumes:
- type: bind
source: "$PWD"
target: /src
- type: bind
source: $HOME/hugo_cache
target: /tmp/hugo_cache
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
profiles:
- local
- lint
cloud-pytest:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: cloud-pytest
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
image: influxdata/docs-pytest
build:
context: .
dockerfile: Dockerfile.pytest
entrypoint:
- /bin/bash
- /src/test/scripts/run-tests.sh
- pytest
command:
# In the command, pass file paths to test.
# The container preprocesses the files for testing and runs the tests.
- content/influxdb/cloud/**/*.md
fix(ci): set CONTENT_PATH env variable for each product
2024-08-07 18:55:26 +00:00
environment:
- CONTENT_PATH=content/influxdb/cloud
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
profiles:
- test
- v2
stdin_open: true
tty: true
volumes:
# Site configuration files.
- type: bind
source: .
target: /src
read_only: true
# Files shared between host and container and writeable by both.
- type: bind
source: ./test/shared
target: /shared
- type: bind
source: ./content/influxdb/cloud/.env.test
target: /app/.env.test
read_only: true
# In your code samples, use `/app/data/<FILE.lp>` or `data/<FILE.lp>` to access sample data files from the `static/downloads` directory.
- type: bind
source: ./static/downloads
target: /app/data
read_only: true
# In your code samples, use `/app/iot-starter` to store example modules or project files.
- type: volume
source: cloud-tmp
target: /app/iot-starter
# Target directory for the content under test.
# Files are copied from /src/content/<productpath> to /app/content/<productpath> before running tests.
- type: volume
source: test-content
target: /app/content
working_dir: /app
cloud-dedicated-pytest:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: cloud-dedicated-pytest
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
image: influxdata/docs-pytest
build:
context: .
dockerfile: Dockerfile.pytest
entrypoint:
- /bin/bash
- /src/test/scripts/run-tests.sh
- pytest
command:
# In the command, pass file paths to test.
# The container preprocesses the files for testing and runs the tests.
- content/influxdb/cloud-dedicated/**/*.md
fix(ci): set CONTENT_PATH env variable for each product
2024-08-07 18:55:26 +00:00
environment:
- CONTENT_PATH=content/influxdb/cloud-dedicated
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
profiles:
- test
- v3
stdin_open: true
tty: true
volumes:
# Site configuration files.
- type: bind
source: .
target: /src
read_only: true
# Files shared between host and container and writeable by both.
- type: bind
source: ./test/shared
target: /shared
- type: bind
source: ./content/influxdb/cloud-dedicated/.env.test
target: /app/.env.test
read_only: true
# The following mount assumes your influxctl configuration file is located at ./content/influxdb/cloud-dedicated/config.toml.
- type: bind
source: ./content/influxdb/cloud-dedicated/config.toml
target: /root/.config/influxctl/config.toml
read_only: true
# In your code samples, use `/app/data/<FILE.lp>` or `data/<FILE.lp>` to access sample data files from the `static/downloads` directory.
- type: bind
source: ./static/downloads
target: /app/data
read_only: true
# In your code samples, use `/app/iot-starter` to store example modules or project files.
- type: volume
source: cloud-dedicated-tmp
target: /app/iot-starter
# Target directory for the content under test.
# Files are copied from /src/content/<productpath> to /app/content/<productpath> before running tests.
- type: volume
source: test-content
target: /app/content
working_dir: /app
cloud-serverless-pytest:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: cloud-serverless-pytest
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
image: influxdata/docs-pytest
build:
context: .
dockerfile: Dockerfile.pytest
entrypoint:
- /bin/bash
- /src/test/scripts/run-tests.sh
- pytest
command:
# In the command, pass file paths to test.
# The container preprocesses the files for testing and runs the tests.
- content/influxdb/cloud-serverless/**/*.md
fix(ci): set CONTENT_PATH env variable for each product
2024-08-07 18:55:26 +00:00
environment:
- CONTENT_PATH=content/influxdb/cloud-serverless
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
profiles:
- test
- v3
stdin_open: true
tty: true
volumes:
# Site configuration files.
- type: bind
source: .
target: /src
read_only: true
# Files shared between host and container and writeable by both.
- type: bind
source: ./test/shared
target: /shared
- type: bind
source: ./content/influxdb/cloud-serverless/.env.test
target: /app/.env.test
read_only: true
# In your code samples, use `/app/data/<FILE.lp>` or `data/<FILE.lp>` to access sample data files from the `static/downloads` directory.
- type: bind
source: ./static/downloads
target: /app/data
read_only: true
# In your code samples, use `/app/iot-starter` to store example modules or project files.
- type: volume
source: cloud-serverless-tmp
target: /app/iot-starter
# Target directory for the content under test.
# Files are copied from /src/content/<productpath> to /app/content/<productpath> before running tests.
- type: volume
source: test-content
target: /app/content
working_dir: /app
clustered-pytest:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: clustered-pytest
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
image: influxdata/docs-pytest
build:
context: .
dockerfile: Dockerfile.pytest
entrypoint:
- /bin/bash
- /src/test/scripts/run-tests.sh
- pytest
command:
# In the command, pass file paths to test.
# The container preprocesses the files for testing and runs the tests.
- content/influxdb/clustered/**/*.md
fix(ci): set CONTENT_PATH env variable for each product
2024-08-07 18:55:26 +00:00
environment:
- CONTENT_PATH=content/influxdb/clustered
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
profiles:
- test
- v3
stdin_open: true
tty: true
volumes:
# Site configuration files.
- type: bind
source: .
target: /src
read_only: true
# Files shared between host and container and writeable by both.
- type: bind
source: ./test/shared
target: /shared
- type: bind
source: ./content/influxdb/clustered/.env.test
target: /app/.env.test
read_only: true
# The following mount assumes your influxctl configuration file is located at ./content/influxdb/clustered/config.toml.
- type: bind
source: ./content/influxdb/clustered/config.toml
target: /root/.config/influxctl/config.toml
read_only: true
# In your code samples, use `/app/data/<FILE.lp>` or `data/<FILE.lp>` to access sample data files from the `static/downloads` directory.
- type: bind
source: ./static/downloads
target: /app/data
read_only: true
# In your code samples, use `/app/iot-starter` to store example modules or project files.
- type: volume
source: clustered-tmp
target: /app/iot-starter
# Target directory for the content under test.
# Files are copied from /src/content/<productpath> to /app/content/<productpath> before running tests.
- type: volume
source: test-content
target: /app/content
working_dir: /app
telegraf-pytest:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: telegraf-pytest
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
image: influxdata/docs-pytest
build:
context: .
dockerfile: Dockerfile.pytest
entrypoint:
- /bin/bash
- /src/test/scripts/run-tests.sh
- pytest
command:
# In the command, pass file paths to test.
# The container preprocesses the files for testing and runs the tests.
- content/telegraf/**/*.md
fix(ci): set CONTENT_PATH env variable for each product
2024-08-07 18:55:26 +00:00
environment:
- CONTENT_PATH=content/telegraf
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
profiles:
- test
stdin_open: true
tty: true
volumes:
# Site configuration files.
- type: bind
source: .
target: /src
read_only: true
# Files shared between host and container and writeable by both.
- type: bind
source: ./test/shared
target: /shared
- type: bind
source: ./content/telegraf/.env.test
target: /app/.env.test
read_only: true
# In your code samples, use `/app/data/<FILE.lp>` or `data/<FILE.lp>` to access sample data files from the `static/downloads` directory.
- type: bind
source: ./static/downloads
target: /app/data
read_only: true
# In your code samples, use `/app/iot-starter` to store example modules or project files.
- type: volume
source: telegraf-tmp
target: /app/iot-starter
# Target directory for the content under test.
# Files are copied from /src/content/<productpath> to /app/content/<productpath> before running tests.
- type: volume
source: test-content
target: /app/content
working_dir: /app
v2-pytest:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: v2-pytest
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
image: influxdata/docs-pytest
build:
context: .
dockerfile: Dockerfile.pytest
entrypoint:
- /bin/bash
- /src/test/scripts/run-tests.sh
- pytest
command:
# In the command, pass file paths to test.
# The container preprocesses the files for testing and runs the tests.
- content/influxdb/v2/**/*.md
fix(ci): set CONTENT_PATH env variable for each product
2024-08-07 18:55:26 +00:00
environment:
- CONTENT_PATH=content/influxdb/v2
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
profiles:
- test
- v2
stdin_open: true
tty: true
volumes:
# Site configuration files.
- type: bind
source: .
target: /src
read_only: true
# Files shared between host and container and writeable by both.
- type: bind
source: ./test/shared
target: /shared
- type: bind
source: ./content/influxdb/v2/.env.test
target: /app/.env.test
read_only: true
# In your code samples, use `/app/data/<FILE.lp>` or `data/<FILE.lp>` to access sample data files from the `static/downloads` directory.
- type: bind
source: ./static/downloads
target: /app/data
read_only: true
# In your code samples, use `/app/iot-starter` to store example modules or project files.
- type: volume
source: v2-tmp
target: /app/iot-starter
# Target directory for the content under test.
# Files are copied from /src/content/<productpath> to /app/content/<productpath> before running tests.
- type: volume
source: test-content
target: /app/content
working_dir: /app
feat(v2): Use Docker Compose with secrets and `_FILE` env variables: - Add guide for installing v2 using Compose, secrets, and InfluxDB `_FILE` env variables. - Add project compose.yaml configuration for the same. - Content looks good in Hugo, but I'm getting an error from pytest that I haven't identified yet.
2024-07-30 15:00:14 +00:00
influxdb2:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: influxdb2
feat(v2): Use Docker Compose with secrets and `_FILE` env variables: - Add guide for installing v2 using Compose, secrets, and InfluxDB `_FILE` env variables. - Add project compose.yaml configuration for the same. - Content looks good in Hugo, but I'm getting an error from pytest that I haven't identified yet.
2024-07-30 15:00:14 +00:00
image: influxdb:2
ports:
- 8086:8086
environment:
DOCKER_INFLUXDB_INIT_MODE: setup
DOCKER_INFLUXDB_INIT_USERNAME_FILE: /run/secrets/influxdb2-admin-username
DOCKER_INFLUXDB_INIT_PASSWORD_FILE: /run/secrets/influxdb2-admin-password
DOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE: /run/secrets/influxdb2-admin-token
DOCKER_INFLUXDB_INIT_ORG: docs
fix(ci): set CONTENT_PATH env variable for each product
2024-08-07 18:55:26 +00:00
DOCKER_INFLUXDB_INIT_BUCKET: get-started
INFLUX_ORG: docs
INFLUX_BUCKET: get-started
feat(v2): Use Docker Compose with secrets and `_FILE` env variables: - Add guide for installing v2 using Compose, secrets, and InfluxDB `_FILE` env variables. - Add project compose.yaml configuration for the same. - Content looks good in Hugo, but I'm getting an error from pytest that I haven't identified yet.
2024-07-30 15:00:14 +00:00
profiles:
- v2
- local
secrets:
- influxdb2-admin-username
- influxdb2-admin-password
- influxdb2-admin-token
volumes:
- type: volume
source: influxdb2-data
target: /var/lib/influxdb2
- type: volume
source: influxdb2-config
target: /etc/influxdb2
chore(ci): Add remark-lint to project - Add remark-lint to compose.yaml - Add base config for remark-lint
2024-07-30 15:07:46 +00:00
remark-lint:
chore(telegraf): Update and improve Telegraf install instructions - Updates Telegraf install instructions, adds more info to promote verifying downloads. - Adds setup for tests. - Makes tests pass in install and configuration docs. - Adds Vale.sh exception to allow duration values inside code blocks. - Adds Dockerfiles for convenience to test install procedures in CentOS and Ubuntu. - Clarifies and fixes config file handling and specifying input and output plugins.
2024-08-26 21:32:16 +00:00
container_name: remark-lint
chore(ci): Add remark-lint to project - Add remark-lint to compose.yaml - Add base config for remark-lint
2024-07-30 15:07:46 +00:00
build:
context: .
dockerfile: .ci/Dockerfile.remark
profiles:
- lint
volumes:
- type: bind
source: ./content
target: /app/content
chore(ci): Improve pre-commit hook, test harness, and linter - Pre-commit hook: - Redo test harness so commands can run in parallel - Cleanup Vale command args - Replace lint-staged and husky with Lefthook. - Pre-push hook: - Scan for package vulnerabilities - Tests - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc. - Each test container (service) runs the prepare-content script before running tests. - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect. - Bind mount influxctl config.toml and .env.test files - Bind mount scripts for faster builds while iterating on test scripts. - Vale: - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 20:08:28 +00:00
volumes:
test-content:
cloud-tmp:
cloud-dedicated-tmp:
cloud-serverless-tmp:
clustered-tmp:
telegraf-tmp:
v2-tmp: