Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC-603] Simplify Toolchain Configuration handling #298

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open

Conversation

dandimeo
Copy link
Contributor

@dandimeo dandimeo commented Oct 19, 2023

Description

This PR aims at simplifying the toolchain configuration process

  • Remove $ARANGODB_BRANCH_* and $ARANGODB_SRC_ environment variables
  • No need to update any file in toolchain/docker to add a new version
  • lighter docker-compose file without that super long environments section

The new toolchain config.yml will now only need

generators: {generators}
 servers:
    {docs-version}: {branch}

example

generators: examples metrics error-codes
 servers:
    "3.11": "arangodb/enterprise-preview:3.11-nightly"

Upstream PRs

  • 3.10: arangodb/enterprise-preview:3.10-nightly
  • 3.11: arangodb/enterprise-preview:3.11-nightly
  • 3.12: arangodb/enterprise-preview:devel-nightly

@arangodb-docs-automation
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-298--docs-hugo.netlify.app

@dandimeo dandimeo marked this pull request as draft October 19, 2023 12:02
@dandimeo
Copy link
Contributor Author

/generate

@dandimeo
Copy link
Contributor Author

@dandimeo dandimeo marked this pull request as ready for review October 24, 2023 15:36
README.md Outdated Show resolved Hide resolved
@Simran-B
Copy link
Contributor

Simran-B commented Oct 25, 2023

With the env var ARANGODB_SRC set to /C/ArangoDB/arangodb and the following Docker config:

generators: examples metrics error-codes optimizer options oasisctl
servers:
  "3.12": arangodb/enterprise-preview:devel-nightly

the toolchain seems to get stuck when I run docker compose up --abort-on-container-exit:

time="2023-10-25T12:15:45+02:00" level=warning msg="The \"OVERRIDE\" variable is not set. Defaulting to a blank string."
[+] Running 1/0
 ✔ Container toolchain  Created                                                                                                                                                                                                                                          0.0s
Attaching to toolchain
toolchain  | [INIT] Toolchain setup
toolchain  | [TOOLCHAIN] Expanded Config file:
toolchain  | generators: examples metrics error-codes optimizer options oasisctl
toolchain  | servers:
toolchain  |   "3.12": arangodb/enterprise-preview:devel-nightly
toolchain  |
toolchain  | [TOOLCHAIN] Clean arangoproxy config file
toolchain  | [INIT] Setup Finished
toolchain  | [TOOLCHAIN] Starting toolchain
toolchain  | [TOOLCHAIN] Generators: examples metrics error-codes optimizer options oasisctl
toolchain  | [] [clean_docker_environment] setup docs_net docker network
toolchain  | [] [clean_docker_environment] setup arangosh and arangodb docker volume
toolchain  | arangosh
toolchain  | [] [clean_docker_environment] Cleanup orphan containers
toolchain  | "docker stop" requires at least 1 argument.
toolchain  | See 'docker stop --help'.
toolchain  |
toolchain  | Usage:  docker stop [OPTIONS] CONTAINER [CONTAINER...]
toolchain  |
toolchain  | Stop one or more running containers
toolchain  | "docker rm" requires at least 1 argument.
toolchain  | See 'docker rm --help'.
toolchain  |
toolchain  | Usage:  docker rm [OPTIONS] CONTAINER [CONTAINER...]
toolchain  |
toolchain  | Remove one or more containers
toolchain  | arangodb/enterprise-preview:devel-nightly 3.12

(hangs here for minutes with no progress)

@arangodb arangodb deleted a comment from cla-bot bot Oct 30, 2023
@arangodb arangodb deleted a comment from cla-bot bot Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants