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

Refactor Build container images page #827

Closed
wants to merge 19 commits into from

Conversation

nginx-seanmoloney
Copy link
Contributor

Proposed changes

Review the docker-images page on the official documentation. Add link to the official docker images. Fix issues with existing commands.

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 9, 2024
@nginx-seanmoloney nginx-seanmoloney self-assigned this Sep 9, 2024
Copy link
Contributor

github-actions bot commented Sep 9, 2024

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-agent/827/

Copy link
Collaborator

@dhurley dhurley left a comment

Choose a reason for hiding this comment

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

I think the Build the official NGINX Agent image with Docker section should be removed and replaced with how to pull the official NGINX Agent images.

@dhurley dhurley added the v2.x Issues and Pull Requests related to the major version v2 label Sep 11, 2024
Copy link
Contributor

github-actions bot commented Sep 11, 2024

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:


I have hereby read the F5 CLA and agree to its terms


4 out of 6 committers have signed the CLA.
✅ (nginx-seanmoloney)[https://github.com/nginx-seanmoloney]
✅ (Jcahilltorre)[https://github.com/Jcahilltorre]
✅ (oliveromahony)[https://github.com/oliveromahony]
✅ (lucacome)[https://github.com/lucacome]
@spencerugbo
@CVanF5
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@Jcahilltorre
Copy link
Contributor

I have hereby read the F5 CLA and agree to its terms

@github-actions github-actions bot added chore Pull requests for routine tasks dependencies labels Sep 12, 2024
@oCHRISo
Copy link
Collaborator

oCHRISo commented Sep 12, 2024

This all looks good. One thing for the "Run the NGINX Agent container" section. Should we give another command so an end user knows how to mount an nginx-agent.conf file?

When running docker run --name nginx-agent -d nginx-agent Agent has default config
Could provide this command to mount a user's nginx-agent.conf file

docker run --name nginx-agent -d \
  -v /path/to/your/nginx-agent.conf:/etc/nginx-agent/nginx-agent.conf \
  nginx-agent

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks dependencies documentation Improvements or additions to documentation v2.x Issues and Pull Requests related to the major version v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants