-
Notifications
You must be signed in to change notification settings - Fork 592
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
Compose dev #3226
base: master
Are you sure you want to change the base?
Compose dev #3226
Conversation
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
f8d06cb
to
fb811f1
Compare
62afd82
to
c310703
Compare
c310703
to
2300458
Compare
As I had time to update the PR, I also optimized some things, like using a Python virtual environment in the Docker image. I thought about:
|
212f1bb
to
08e8de9
Compare
Thanks for the suggested changes to the development setup @jbaptperez. I appreciate you taking the time to propose these updates to improve the developer experience, especially for those in restricted environments. The changes are quite extensive and touch many core parts of our development setup, so we'll need some time to thoroughly review and test them. While flexibility is important, we aim to maintain a simple and easily reproducible development environment that works out-of-the-box on a typical Linux machine. We generally encourage developers to manage their own custom configurations for specific environments, such as those found in corporate settings. Therefore, we may incorporate some of your proposed changes while declining others to ensure we keep the core setup as straightforward as possible. |
08e8de9
to
fcf14ef
Compare
@jkppr, actually, the apparent change is not so big: Everything run into a single container with I paid special attention to keeping default settings so that the behaviour without changes is the same as before. A big change reported by Git is the deletion of the recently added The rest is close to the previous behaviour, with a single real difference: I duplicated the However, I understand your message and I am open to suggestions. |
fcf14ef
to
2161c61
Compare
The yarn.lock file speed-ups an initial set-up but freezes the registry URL, which can be different in the ~/.npmrc file when developing in a company.
Markdown formatting, typos.
Makes the repository handle file line endings. This helps to make it cross-platform, asserting some files are Unix-ended.
Uses the prefeed name of the Compose specification.
Changes: - Removes the deprecated "version" field, - Adds a toplevel "name" field (prefix of container names nad network), - Adds a toplevel "network" field, with a common "timesketch-dev" network, - Removes container names (depends on and toplevel name and service names), - Do not bind to the 127.0.0.1 interface only (0.0.0.0), - Removes useless "links" (common network), - Refactors environment variables to don't use a YAML array, - Removes "restart" fields to detect undesired crashes in development, - Binds ports of other services to the host (opensearch, redis).
Adds .gitignore files. Dramatically improves an image build in a development context.
Adapts the list to the latest version of the repository: - Fixes moved ones, - Deletes removed ones.
Changes are: - Allows Docker image builds in a restricted company context (limited access to remote Ubuntu, Python or Node repositories) using variables, - Centralizes variables in a .env file (not versioned), - Adds a .env.template file as .env template with predefined variables, - Use a distinct directory for every service dependencies, - Use named volumes to avoid anonymous ones (PostgreSQL, OpenSearch, Redis and Prometheus), - Use a per-service environment file, - Simplifies how development configuration files are transferred to Timesketch, - Simplifies manipulation of containers using Compose CLI instead of the Docker one, - Simplify and optimizes the Timesketch entrypoint, - Updates the Bash scripts to start frontend-ng, - Updates related documentation. Use named volumes in Compose development PostgreSQL, Redis and Prometheus declare volumes in their Dockerfile. This leads to anonymous volume creations if they are not declared in Compose.
Avoids using the system environment.
2161c61
to
94e3cad
Compare
IMPORTANT: All Pull Requests should be connected to an issue, if you don't
have an issue, please start by creating an issue and link it to the PR.
Please provide enough information so that others can review your pull request:
.env
file,Checks
Closing issues
Closes #3225.