Skip to content

initial files #3

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

Merged
merged 1 commit into from
Oct 30, 2024
Merged

initial files #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changelog

## 1.0.0 (Month Date, Year)
## 1.0.0 (October 29, 2024)

Initial release of the NGINX template repository.
Initial release of the NGINX One Workshop Repo - Chris Akker.
47 changes: 10 additions & 37 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,26 @@

The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!

#### Table of Contents
#### Table Of Contents

- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [Code Guidelines](#code-guidelines)
- [Code of Conduct](/CODE_OF_CONDUCT.md)
[Getting Started](#getting-started)

[Contributing](#contributing)

[Code of Conduct](https://github.com/nginxinc/nginx-azure-workshops/blob/main/CODE_OF_CONDUCT.md)

## Getting Started

Follow the instructions on the README's [Getting Started](/README.md#Getting-Started) section to get this project up and running.
Follow our [Getting Started Guide](https://github.com/nginxinc/nginx-azure-workshops/blob/main/README.md#Getting-Started) to get this project up and running.

<!-- ### Project Structure (OPTIONAL) -->

## Contributing

### Report a Bug

To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**

### Suggest a Feature or Enhancement

To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.

### Open a Pull Request (PR)

- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are **tested** and ready for review.
- Fill in the [PR template](/.github/pull_request_template.md).

**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.

#### F5 Contributor License Agreement (CLA)

F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be incorporated into an F5 Open Source repository.

If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.

## Code Guidelines

<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](https://github.com/nginxinc/nginx-azure-workshops/blob/main/SECURITY.md).**

### Git Guidelines
### Provide Feedback on a Lab Exercise

- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
- In the subject line, use the present tense ("Add feature" not "Added feature").
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the subject line to 72 characters or less.
- Reference issues and pull requests liberally after the subject line.
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).
To send us feedback, please create an issue on GitHub with the label `feedback` using the available feedback template.
107 changes: 60 additions & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,76 +1,89 @@
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/template-repository/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/template-repository)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/template-repository/blob/main/SUPPORT.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginxinc/template-repository/main/CODE_OF_CONDUCT.md)
# NGINX ONE Console Workshop 102

# NGINX Template Repository
![](labs/media/nginx-one-icon.png)

## What is included on this template?
<br/>

This template includes all the scaffolding you need to get started on an OSS repository that meets the required NGINX criteria:
This Repo is for learning the **`NGINX ONE Console`**, with Instructor Lead and Self-paced and Hands-on Lab Exercises and Lab Guides that will teach a student using real Nginx instances with NGINX ONE.

- [Apache License 2.0](/LICENSE) (required for all NGINX OSS projects).
- [`.gitignore`](/.gitignore) with some minimal sensible defaults.
- [Issue](/.github/ISSUE_TEMPLATE) and [PR](/.github//pull_request_template.md) templates.
- [Contributing](/CONTRIBUTING.md) guidelines.
- [Support](/SUPPORT.md) guidelines for either community and/or commercial support (uncomment the commercial block if necessary).
- [Security](/SECURITY.md) guidelines for reporting major vulnerabilities.
- [Code of Conduct](/CODE_OF_CONDUCT.md).
- [F5 CLA workflow](/.github/workflows/f5-cla.yml). For more details on the action please check the [F5 CLA signature datastore repository](https://github.com/f5/f5-cla-data).
- Open Source Security Foundation (OSSF) Scorecard [(implemented via a GitHub Action)](/.github/workflows/ossf_scorecard.yml)
- [README](/README.md) placeholder. How you structure the README is up to you (although the template provides placeholder sections), but you will need to include:
- A [repostatus](https://www.repostatus.org/) badge.
- An OSSF Scorecard badge. (Optional -- Some projects will by their nature have low scores. In such a case you might want to remove this badge!).
- A community and/or commercial support badge. Include the latter -- and replace the commented out badge/URL placeholder with the relevant support URL -- if this repository contains a commercially supported project. You can find a commented out example below the community badge in this README.
- A contributor covenant/code of conduct badge. (Optional -- If you already have multiple badges and want to reduce clutter, simply including the actual code of conduct is enough!)
- An explicit link back to the [Apache License 2.0](/LICENSE).
- An up to date copyright notice.
- [Changelog](/CHANGELOG.md) placeholder. (Optional -- A changelog is recommended, but it is not required and can diverge in format from the placeholder here included.)
- [Codeowners](/.github/CODEOWNERS) placeholder. (Optional -- Codeowners is a useful feature, but not all repositories require them.)
<br>

**Note:** If you created a public repository before this template became available (or you didn't know about it's existence), please include any missing files found here in your repository. There is no need if you have a private repository, but we still recommend you include all of the above scaffolding should the repository ever become public.
## Audience

## How do I use this template?
This Workshop is meant for Modern Application Developers, DevOps, Platform Ops, and SRE engineers working with NGINX, NGINX Plus, Docker - how they are managed, monitored, and configured using the ONE Console. Using various Nginx instances, you will connect them to NGINX ONE and explore the Console.

**DO NOT FORK** -- this template is meant to be used from the **[`Use this template`](https://github.com/nginxinc/template-repository/generate)** feature.
`The Student taking this Workshop must have the basic skills and knowledge with the following:`

1. Click on **[`Use this template`](https://github.com/nginxinc/template-repository/generate)**.
2. Give a name to your project.
3. Wait until the first run of CI finishes (GitHub Actions will process the template and commit to your new repo).
4. Clone your new project and tweak any of the placeholders if necessary. Pay special attention to the README!
5. Happy coding!
- Nginx Opensource or Plus
- Nginx configurations: files, directives, and variables
- Chrome Browser
- Linux OS / desktop skills
- Optional: Docker container concepts
- Optional: TLS certificates
- Optional: CVE Security concepts

**NOTE**: **WAIT** until the first CI run on GitHub Actions finishes before cloning your new project.
You should be proficient with the following technologies and concepts.

---
- Nginx Webserver and Reverse Proxy
- HTTP 1.1 Protocol, TLS
- Various Desktop tools; Visual Studio, Linux, Terminal, Chrome

<!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -- PLACEHOLDER SECTIONS HAVE BEEN INCLUDED FOR YOUR CONVENIENCE -->
<br/>

[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/nginx-one-workshops/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/nginx-one-workshops)
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md) <!-- [![Commercial Support](https://badgen.net/badge/support/commercial/cyan?icon=awesome)](<Insert URL>) -->
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)
## Knowledge and Skills Requirements

# nginx_one_workshops
<br/>

## Requirements
NGINX ONE Console | Hands-On Labs
:-------------------------:|:-------------------------:
![](labs/media/nginx-one-icon.png) | ![](labs/media/developer-seated.svg)

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam elit turpis, varius et arcu elementum, viverra rhoncus sem. Aliquam nec sodales magna, et egestas enim. Mauris lobortis ultrices euismod. Pellentesque in arcu lacus. Mauris cursus laoreet nulla, ac vehicula est. Vestibulum eu mauris quis lorem consectetur aliquam ac nec quam. Vestibulum commodo pharetra mi, at bibendum neque faucibus ut. Mauris et tortor sed sem consectetur eleifend ut non magna. Praesent feugiat placerat nibh, varius viverra orci bibendum sed. Vestibulum dapibus ex ut pulvinar facilisis. Quisque sodales enim et augue tempor mattis. Suspendisse finibus congue felis, ac blandit ligula. Praesent condimentum ultrices odio quis semper. Nunc ultrices, nibh quis mattis pellentesque, elit nulla bibendum felis, quis dapibus erat turpis ac urna.
<br/>

To meet the Prerequisite skills requirement, there are other Workshops from Nginx to help you prepare. The student should have completed the Nginx Basics Workshop 101, prior to taking this workshop. (Or have equivalent knowledge).

- Nginx Basics Workshop - 101 (https://github.com/nginxinc/nginx-basics-workshops/tree/master/labs)

See [Lab0 Readme](/labs/lab0/readme.md) for the Hardware/Software and Skills Prerequisites for taking this Workshop and completing the Lab Exercises.

<br/>

## Getting Started

Duis sit amet sapien vel velit ornare vulputate. Nulla rutrum euismod risus ac efficitur. Curabitur in sagittis elit, a semper leo. Suspendisse malesuada aliquam velit, eu suscipit lorem vehicula at. Proin turpis lacus, semper in placerat in, accumsan non ipsum. Cras euismod, elit eget pretium laoreet, tortor nulla finibus tortor, nec hendrerit elit turpis ut eros. Quisque congue nisi id mauris molestie, eu condimentum dolor rutrum. Nullam eleifend elit ac lobortis tristique. Pellentesque nec tellus non mauris aliquet commodo a eu elit. Ut at feugiat metus, at tristique mauris. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae;
Review the Github Repo content for the Nginx Basics Workshop 101. If you have taken this Workshop, and understand the content, you can successfully complete the Lab exercises in this Nginx ONE Workshop. It is HIGHLY recommended that you complete the 101 Workshop prior.

It will take approximately 1 hour to complete the Nginx ONE Workshop.

<br/>

## How to Use

Maecenas at vehicula justo. Suspendisse posuere elementum elit vel posuere. Etiam quis pulvinar massa. Integer tempor semper risus, vitae maximus eros ullamcorper vitae. In egestas, ex vitae gravida sodales, ipsum dolor varius est, et cursus lorem dui a mi. Morbi faucibus ut nisi id faucibus. Sed quis ullamcorper ex. In et dolor id nunc interdum suscipit.
The content and lab exercises are presented in a sequence as you build and add additional Nginx instances and functionality as you progress. It is essential that the Lab Exercises are completed in the order provided. This content provided is for example only, is not for production workloads. The user of this information assumes all risks.

- Click [LabGuide](labs/readme.md) to begin the Lab Exercises.
- Click [Lab0 Readme](labs/lab0/readme.md) to review the Lab0 Prerequisites - "Know before you Go".

<br/>

## Contributing

Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
Please see the [contributing guide](https://github.com/nginxinc/nginx-one-workshops/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.

<br/>

### Authors

- Chris Akker - Solutions Architect - Community and Alliances @ F5, Inc.
- Shouvik Dutta - Solutions Architect - Community and Alliances @ F5, Inc.
- Adam Currier - Solutions Architect - Community and Alliances @ F5, Inc.

-------------

<br/>

## License

[Apache License, Version 2.0](/LICENSE)
[Apache License, Version 2.0](https://github.com/nginxinc/nginx-one-workshops/blob/main/LICENSE)


&copy; [F5, Inc.](https://www.f5.com/) 2024
46 changes: 30 additions & 16 deletions SUPPORT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,56 @@

We use GitHub for tracking bugs and feature requests related to this project.

Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`. Alternatively, start a GitHub discussion!
Don't know how something in the nginx_azure_workshops works? Curious if the nginx_azure_workshops can achieve your desired functionality? Please open an issue on GitHub with the label `question`.

<br/>

## NGINX Specific Questions and/or Issues

This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!

<!--
To be replaced with Discourse
<br/>

### Community Slack
## F5 Support

We have a community [Slack](https://nginxcommunity.slack.com/)!
If you’re an F5 customer with NGINX Plus and an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).

If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up. (Let us know if the link does not seem to be working at <[email protected]>!)
<br/>

Once you join, check out the `#beginner-questions` and `nginx-users` channels :)
-->
## Documentation

### Documentation
For a comprehensive list of all NGINX directives, check out <http://nginx.org/en/docs/dirindex.html>.

For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
For a comprehensive list of all NGINX variables, check out <http://nginx.org/en/docs/varindex.html>.

For a comprehensive list of administration and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
For a comprehensive list of admin and deployment guides for NGINX Plus, check out <https://docs.nginx.com/nginx/admin-guide/>.

For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>.

</br>

### Mailing List

Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!

<br/>

## Contributing

Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
Please see the [contributing guide](https://github.com/nginxinc/nginx-azure-workshops/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.

<!-- ## Commercial Support
<br/>

Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.f5.com/products/get-f5/) or check your contract details for more information! -->
## Commercial Support

## Community Support
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.nginx.com/contact-sales/) or check your contract details for more info!

This project does **not** offer commercial support. Community support is offered on a best effort basis through either GitHub issues/PRs/discussions or through any of our active communities.
<br/>

### Community Slack

We have a community [Slack](https://nginxcommunity.slack.com/)!

If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up (and let us know if the link does not seem to be working!)

Once you join, check out the `#beginner-questions` and `nginx-users` channels :)
Loading
Loading