Skip to content

9540 - more docs for container usage - #9584

Merged
kcondon merged 11 commits into
IQSS:developfrom
poikilotherm:9540-ct-dev-docs
Jun 23, 2023
Merged

9540 - more docs for container usage#9584
kcondon merged 11 commits into
IQSS:developfrom
poikilotherm:9540-ct-dev-docs

Conversation

@poikilotherm

@poikilotherm poikilotherm commented May 10, 2023

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:

This pull request will satisfy the required documentation bits for milestone A of the containerization strategy.

Which issue(s) this PR closes:

Special notes for your reviewer:
None so far.

Suggestions on how to test this:
Just take a look at the RTFD preview - no code changes involved.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Nope.

Is there a release notes update needed for this change?:
Dunno.

Additional documentation:
None.

@poikilotherm poikilotherm added Component: Containers Anything related to cloudy Dataverse, shipped in containers. Feature: Container Guide labels May 10, 2023
@pdurbin pdurbin added the Size: 3 A percentage of a sprint. 2.1 hours. label May 10, 2023
@poikilotherm

Copy link
Copy Markdown
Contributor Author

@pdurbin hope you don't mind, but I'm unassigning myself and let you add the remaining bits 'n' bobs. Please feel free to switch this to "ready for review".

@poikilotherm poikilotherm removed their assignment May 12, 2023
Comment thread doc/sphinx-guides/source/container/dev-usage.rst
Comment thread doc/sphinx-guides/source/container/dev-usage.rst Outdated
@poikilotherm
poikilotherm marked this pull request as ready for review June 1, 2023 17:02
@poikilotherm

Copy link
Copy Markdown
Contributor Author

@pdurbin I marked the PR as ready for review. If you feel like we should address the rest of the open points in #9540, please go ahead 😄

(These are the open points:)

- [ ] Update Windows dev page: https://guides.dataverse.org/en/5.13/developers/windows.html
  - A cloned Dataverse by Git for Windows with the line-ending setting is set to always LF (core.autocrlf=input)
- [ ] Explain how to run just the dev_smtp server: `docker-compose -f docker-compose-dev.yml up dev_smtp`
- [ ] Explain the different development approaches bare metal, docker, Vagrant and name the preferred one.

@KimJinYeon

Copy link
Copy Markdown
Contributor

@pdurbin

If mvn -Pct clean package docker:run is not working, docker-maven-plugin config should be checked.

On RockyLinux 8, mvn -Pct clean package didn't work with error message below.

[ERROR] Failed to execute goal io.fabric8:docker-maven-plugin:0.42.1:build (default-build) on project dataverse: Execution default-build of goal io.fabric8:docker-maven-plugin:0.42.1:build failed: No given, no DOCKER_HOST environment variable, no read/writable '/var/run/docker.sock' or '//./pipe/docker_engine' and no external provider like Docker machine configured -> [Help 1]

Screenshot 2023-06-16 at 9 15 26 AM

This error occurs when you try to run with docker-maven-plugin and $DOCKER_HOST is not given.
This error could be solved by giving $DOCKER_HOST.

For example, assign $DOCKER_HOST with "/var/run/docker.sock".

For further information, see link below.
fabric8io/docker-maven-plugin#1584
https://dmp.fabric8.io/#global-configuration

Thanks for your help in solving this problem @pdurbin .

@pdurbin pdurbin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some commits. This is ready to merge! Thanks, @poikilotherm!

@pdurbin pdurbin removed their assignment Jun 23, 2023
@kcondon kcondon self-assigned this Jun 23, 2023
@kcondon
kcondon merged commit 0cad39a into IQSS:develop Jun 23, 2023
@pdurbin pdurbin added this to the 5.14 milestone Jul 12, 2023
@poikilotherm
poikilotherm deleted the 9540-ct-dev-docs branch October 2, 2024 06:38
@cmbz cmbz added FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) and removed FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) labels Jan 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Containers Anything related to cloudy Dataverse, shipped in containers. Feature: Container Guide Size: 3 A percentage of a sprint. 2.1 hours.

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Docs for milestone A of containerization plan

6 participants