Skip to content

feat: improve docker docs #587

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

Merged
merged 2 commits into from
Mar 6, 2024
Merged

feat: improve docker docs #587

merged 2 commits into from
Mar 6, 2024

Conversation

JTorreG
Copy link
Contributor

@JTorreG JTorreG commented Mar 5, 2024

Proposed changes

Corrects the steps to build the official Alpine-based Agent images.

Adds a note about building images for unsupported OSs

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

@JTorreG JTorreG self-assigned this Mar 5, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 5, 2024
Copy link

netlify bot commented Mar 5, 2024

Deploy Preview for agent-public-docs ready!

Name Link
🔨 Latest commit a43f068
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/65e76845aab5860008cd7aed
😎 Deploy Preview https://deploy-preview-587--agent-public-docs.netlify.app/nginx-agent/installation-upgrade/container-environments/docker-images
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov-commenter
Copy link

codecov-commenter commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.12%. Comparing base (6d3944a) to head (a43f068).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #587   +/-   ##
=======================================
  Coverage   66.12%   66.12%           
=======================================
  Files         118      118           
  Lines       13461    13461           
=======================================
  Hits         8901     8901           
  Misses       3959     3959           
  Partials      601      601           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@mtbChef mtbChef left a comment

Choose a reason for hiding this comment

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

I'd say this is acceptable, but it is missing some info that would make it less frustrating for customers. As an example, the steps to access the container shell and restart Agent after enabling gRPC and REST are missing.

@JTorreG
Copy link
Contributor Author

JTorreG commented Mar 6, 2024

waiting on testing of the steps in the docs as per @ninaforsyth 's request

@JTorreG JTorreG merged commit 81f141a into main Mar 6, 2024
@JTorreG JTorreG deleted the docker-support-hotfix branch March 6, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants