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.

Sign up for GitHub

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

Jump to bottom

docs: document development process #280

Merged
merged 5 commits into from
Jun 27, 2023
Merged

docs: document development process #280

merged 5 commits into from
Jun 27, 2023

Conversation

kuisathaverat
Copy link
Contributor

This PR completes the documentation about how to build the Docker images, what Docker images are here, what it is the use of every Docker image, and how to make updates.

Closes https://github.com/elastic/observability-robots/issues/1547

@kuisathaverat kuisathaverat requested review from a team April 3, 2023 14:21
@kuisathaverat kuisathaverat self-assigned this Apr 3, 2023
@mergify
Copy link

mergify bot commented Apr 3, 2023

This pull request does not have a backport label. Could you fix it @kuisathaverat? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v./d./d is the label to automatically backport to the 1./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip label Apr 3, 2023
kuisathaverat
kuisathaverat commented Apr 3, 2023
View reviewed changes
README.md

golang-crossbuild is a set of Docker images containing the requisite
cross-compilers for cross compiling Go applications. The cross-compilers are
needed when the application uses [cgo](https://golang.org/cmd/cgo/).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

CGO is not recommended when you use cross-compilers. See cgo is not Go

@elasticmachine
Copy link

elasticmachine commented Apr 3, 2023 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-06-27T11:50:54.909+0000

  • Duration: 58 min 12 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

v1v
v1v reviewed Apr 10, 2023
View reviewed changes
Copy link
Member

@v1v v1v left a comment

Choose a reason for hiding this comment

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

Some minor NITs and typos. Otherwise, LGTM, thanks!!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@kuisathaverat @v1v
Apply suggestions from code review
05ee3aa 
Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com>
@cachedout
Copy link

@jlind23 This is related to the transition of golang-crossbuild to Ingest. Can you please assign some reviewer(s) from Ingest to have a look at this? I would like to know if they (and you) find this documentation sufficient or if we should also schedule a call to review the process and answer questions. Thanks.

@jlind23
Copy link
Contributor

jlind23 commented May 3, 2023

@mrodm @alexsapran could you please take a look at this?

@jlind23
Copy link
Contributor

jlind23 commented May 4, 2023

@cachedout I just discussed this with @alexsapran and it makes sense for us to take this over, however our bandwidth is very limited until we hire a new Eng Prod engineer. This req is ongoing but no one has joined yet. Would be great if your team can hold the fort until further notice.

cc @amitkanfer

@cachedout
Copy link

@jlind23 That is fine. Thanks for letting me know.

v1v
v1v reviewed May 5, 2023
View reviewed changes
README.md
This Docker image is the base image for all the other Docker images, it contains the base packages fro cross compilation.
It is build for amd64 and arm64 architectures for Debian 9+.
In the folder you can find the `sources.list` file that contains the list of repositories to use to install the packages,
this file is different for each Debian version. In some cases, this file must point to `http://archive.debian.org/debian` instead of `http://deb.debian.org/debian` to be able to install the packages, this happens when the Debian version reach the end of life.
Copy link
Member

Choose a reason for hiding this comment

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

That's pretty neat!! ❤️

I recently fixed some issues with Debian 8 and Debian 9

@mergify
Copy link

mergify bot commented Jun 22, 2023

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b docs/docker_images_docs upstream/docs/docker_images_docs
git merge upstream/main
git push upstream docs/docker_images_docs

@kuisathaverat kuisathaverat enabled auto-merge (squash) June 27, 2023 11:50
@kuisathaverat kuisathaverat merged commit 2736a12 into main Jun 27, 2023
@kuisathaverat kuisathaverat deleted the docs/docker_images_docs branch June 27, 2023 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@v1v v1v v1v approved these changes

@cachedout cachedout cachedout approved these changes

Assignees

@kuisathaverat kuisathaverat

Labels
backport-skip
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kuisathaverat @elasticmachine @cachedout @jlind23 @v1v