-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
we are now an official separate project
- Loading branch information
Showing
207 changed files
with
17,749 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
secrets.yml | ||
users.yml | ||
extra_vars.yml | ||
*.txt | ||
.vagrant/* | ||
TODO | ||
TODO.md | ||
bak/ | ||
*.BAK | ||
*.DS_Store | ||
*.pem | ||
instructor_inventory.txt | ||
tools/aws_lab_setup/aws-private.pem | ||
*.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
MIT LICENSE | ||
|
||
Copyright 2017 Red Hat, Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,68 @@ | ||
# linklight | ||
Training Course for Ansible Network Automation | ||
# Ansible Lightbulb | ||
|
||
The Ansible Lightbulb project is an effort to provide a content toolkit and educational reference for effectively communicating and teaching Ansible topics. | ||
|
||
Lightbulb began life as the content that supported Ansible's training program before it joined the Red Hat family focused solely on Linux server automation. | ||
|
||
This content is now taking on a new life as a multi-purpose toolkit for effectively demonstrating Ansible's capabilities or providing informal workshop training in various forms -- instructor-led, hands-on or self-paced. | ||
|
||
Over time Lightbulb will be expanded to include advanced and developer topics in addition to expanding beyond linux server automation and into Windows and network automation. | ||
|
||
To support these objectives, the project provides a lab provisioner tool for creating an environment to present and work with Lightbulb content. | ||
|
||
### What's Provided | ||
|
||
The Ansible Lightbulb project has been designed to be used as a toolkit and best practices reference for Ansible presentations ranging from demos thru self-paced learning thru hands-on workshops. Here you will find: | ||
|
||
* Workshops | ||
* Presentation Decks | ||
* Lab Provisioner | ||
|
||
#### Examples | ||
|
||
The content in `examples/` is the heart of what Lightbulb has to offer. They are complete Ansible playbooks that demonstrate the most fundamental features and most common use patterns. | ||
|
||
These examples are an excellent educational reference for communicating how Ansible works in a clear, focused and consistent manner using recommended best practices. | ||
|
||
This content is a great source for canned demos or something you can walk-thru to illustrate automating with Ansible to a group. Some of the examples serve as the solutions to the workshops. | ||
|
||
#### Workshops | ||
|
||
The content of `workshops/` are a collection of Markdown documents and applicable resources for providing hands-on assignments for learning how to automate with Ansible. | ||
|
||
Instructor notes on the execution and solution to all workshops can be found in `facilitator/solutions/`. | ||
|
||
#### Presentation Decks | ||
|
||
The content of `decks/` are collection of presentation decks using the [reveal.js framework](http://lab.hakim.se/reveal-js/) for delivering instructor-led or hands-on instruction. | ||
|
||
#### Lab Provisioner | ||
|
||
Lightbulb provides a lab provisioner utility for creating a personal lab environment for each student. Currently only Amazon Web Services (AWS) is supported in us-east-1 and us-west-1 with the foundation to support other regions in place. | ||
|
||
### Requirements | ||
|
||
True to its philosophy and The Ansible Way, Lightbulb has been developed so that using Lightbulb is as simple and low-overhead as possible. Requirements depend on the format and delivery of the Lightbulb content. | ||
|
||
* Modern HTML5 Standard Compliant Web Browser | ||
* A recent stable version of Python 2.7 and the latest stable version of the boto libraries. | ||
* The latest stable versions of Ansible. | ||
* A SSH client such as PuTTY or Mac OSX Terminal. | ||
* An AWS account or local Vagrant setup. | ||
|
||
#### Assumed Knowledge | ||
|
||
For hands-on or self-paced training, students should have working knowledge of using SSH and command line shell (BASH). The ability to SSH from their personal laptop to a lab environment hosted in a public cloud can also be required based on the format and presentation of the context. | ||
|
||
For demos and instructor-led exercises, conceptual understanding of linux system admin, DevOps and distributed application architecture is all that is required. | ||
|
||
### Reference | ||
|
||
* [Ansible Documentation](http://docs.ansible.com) | ||
* [Ansible Best Practices: The Essentials](https://www.ansible.com/blog/ansible-best-practices-essentials) | ||
|
||
### License | ||
|
||
Red Hat, the Shadowman logo, Ansible, and Ansible Tower are trademarks or registered trademarks of Red Hat, Inc. or its subsidiaries in the United States and other countries. | ||
|
||
All other parts of Ansible Lightbulb are made available under the terms of the [MIT License](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
theme: jekyll-theme-dinky |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Contribute | ||
|
||
We take pull requests! | ||
|
||
## Create a fork! | ||
Create a fork on your own Github project (or your personal space) | ||
|
||
[Github Documentation on Forking a repo](https://help.github.com/articles/fork-a-repo/) | ||
|
||
## Stay in Sync | ||
It is important to know how to keep your fork in sync with the upstream Lightbulb project. | ||
|
||
### Configuring Your Remotes | ||
Configure Lightbulb as your upstream so you can stay in sync | ||
|
||
```bash | ||
git remote add upstream https://github.com/ansible/lightbulb.git | ||
``` | ||
|
||
### Rebasing Your Branch | ||
Three step process | ||
|
||
```bash | ||
git pull --rebase upstream master | ||
``` | ||
|
||
```bash | ||
git status | ||
``` | ||
|
||
### Updating your Pull Request | ||
```bash | ||
git push --force | ||
``` | ||
|
||
More info on docs.ansible.com: [Rebasing a Pull Request](http://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html) | ||
|
||
## Create a pull requests | ||
|
||
Make sure you are not behind (in sync) and then submit a PR to LinkLight. | ||
[Read the Pull Request Documentation on Github.com](https://help.github.com/articles/creating-a-pull-request/) | ||
|
||
Just because you submit a PR, doesn't mean that it will get accepted. Right now the QA process is manual for lightbulb, so provide detailed directions on | ||
|
||
- WHY? Why did you make the change? | ||
- WHO? Who is this for? If this is something for a limited audience it might not make sense for all users. | ||
- BEST PRACTICE? Is this the "best" way to do this? Link to documentation or examples where the way you solved your issue or improved Lightbulb is the best practice for teaching or building workshops. | ||
|
||
Being more descriptive is better, and has a higher change of getting merged upstream. Communication is key! Just b/c the PR doesn't get accepted right away doesn't mean it is not a good idea. Lightbulb has to balance many different types of users. Thank you for contributing! | ||
|
||
# Going Further | ||
The following links will be helpful if you want to contribute code to the Lightbulb project, or any Ansible project: | ||
- [Ansible Committer Guidelines](http://docs.ansible.com/ansible/latest/committer_guidelines.html) | ||
- [Learning Git](https://git-scm.com/book/en/v2) |
Oops, something went wrong.