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

Gabeaws/jenkins readme updates #145

Merged
merged 22 commits into from
Jul 27, 2024
Merged

Conversation

gabebatista
Copy link
Contributor

Issue number:

Summary

Version one of Jenkins module documentation

Changes

Added Jenkins module documentation.
Sections added:

  • Description
  • Architecture Diagram
  • Prerequisites
    • Creating Route 53 Hosted Zones
    • Creating Public Certificate
    • Upload secrets to AWS Secrets Manager
    • Generate Jenkins Agent AMI
  • Installation instructions
  • Deploy instructions
  • Accessing Jenkins
  • Configuring Jenkins
    • Retrieving admin password
    • First-time configurations
    • Installing EC2 Fleet Plugin

User experience

The changes help to improve the users experience by walking them through the setup and configuration of the Jenkins module.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented
Is this a breaking change? No

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created might not be successful.

@gabebatista gabebatista added documentation Improvements or additions to documentation modules Updates to project modules labels Jul 17, 2024
@gabebatista gabebatista requested a review from a team as a code owner July 17, 2024 14:56
docs/media/Images/jenkins-module-architecture.jpg Outdated Show resolved Hide resolved
modules/jenkins/example.tfvars Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Show resolved Hide resolved
modules/jenkins/README.md Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Show resolved Hide resolved
@henrykie henrykie marked this pull request as draft July 18, 2024 12:08
Copy link
Contributor

@henrykie henrykie left a comment

Choose a reason for hiding this comment

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

Couple minor things. Main concern is that a lot of the details around setup probably belong in sample documentation, not module documentation.

docs/media/Images/access-jenkins.png Outdated Show resolved Hide resolved
modules/jenkins/example.tfvars Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Show resolved Hide resolved
docs/media/Images/jenkins-module-architecture.jpg Outdated Show resolved Hide resolved
@gabebatista gabebatista marked this pull request as ready for review July 22, 2024 19:29
Copy link
Contributor

@henrykie henrykie left a comment

Choose a reason for hiding this comment

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

Minor things, but it looks good.

modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Outdated Show resolved Hide resolved
modules/jenkins/README.md Show resolved Hide resolved
Copy link
Member

@kylesomers kylesomers left a comment

Choose a reason for hiding this comment

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

see feedback on jenkins password handling. let's hold off on merging this until that fix is completed.

Copy link
Member

Choose a reason for hiding this comment

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

Modify this to write to Secrets Manager, not log output. Cut a PR to fix that in the module

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe that password only works for the first time configuration then gets replaced with the user you create in the setup process. To change this behavior we would need to edit the jenkins docker image we use to setup the service, meaning we would need to distribute our own image to be used. @henrykie please correct me if I'm wrong about this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also @kylesomers we do not have the capacity to update the way that Jenkins writes to logs. This module uses the default image available on Dockerhub without any extensions or adjustments to the entrypoint. For initial release we aren't modifying this, so we cannot adjust the way that Jenkins is initially configured.

@henrykie
Copy link
Contributor

@gabebatista Hey dude - trying to get the commit history on this branch cleaned up. The rebase got messed up. Your PR shouldn't include all these file changes we made to Jenkins pipelines, etc.

@henrykie henrykie force-pushed the gabeaws/jenkins-README-updates branch from c1c0809 to a821b23 Compare July 26, 2024 23:06
@henrykie
Copy link
Contributor

Still pretty messy, but definitely cleaned up a good amount.

@henrykie henrykie force-pushed the gabeaws/jenkins-README-updates branch 2 times, most recently from 1738584 to 3c0820a Compare July 26, 2024 23:17
@henrykie henrykie force-pushed the gabeaws/jenkins-README-updates branch from 3c0820a to 1f89ef0 Compare July 27, 2024 01:00
@henrykie henrykie removed the request for review from kylesomers July 27, 2024 01:03
@henrykie henrykie dismissed kylesomers’s stale review July 27, 2024 01:03

Addressed changes. Merging.

@henrykie henrykie merged commit 93425e6 into main Jul 27, 2024
5 checks passed
@henrykie henrykie deleted the gabeaws/jenkins-README-updates branch August 9, 2024 15:02
jcwolfaws pushed a commit to jcwolfaws/cloud-game-development-toolkit that referenced this pull request Dec 10, 2024
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 modules Updates to project modules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants