diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..0164155b8 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Community Code of Conduct + +Please see the official [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html). diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c386882c4..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -##### ISSUE TYPE - - Bug Report - -##### SUMMARY - - -##### ENVIRONMENT -* AWX version: X.Y.Z -* Operator version: X.Y.Z -* Kubernetes version: -* AWX install method: openshift, minishift, docker on linux, docker for mac, boot2docker - -##### STEPS TO REPRODUCE - - - -##### EXPECTED RESULTS - - - -##### ACTUAL RESULTS - - - -##### ADDITIONAL INFORMATION - - - -##### AWX-OPERATOR LOGS diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..539ec115e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,125 @@ +--- +name: Bug Report +description: "🐞 Create a report to help us improve" +body: + - type: markdown + attributes: + value: | + Bug Report issues are for **concrete, actionable bugs** only. + For debugging help or technical support, please see the [Get Involved section of our README](https://github.com/ansible/awx-operator#get-involved) + + - type: checkboxes + id: terms + attributes: + label: Please confirm the following + options: + - label: I agree to follow this project's [code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html). + required: true + - label: I have checked the [current issues](https://github.com/ansible/awx-operator/issues) for duplicates. + required: true + - label: I understand that the AWX Operator is open source software provided for free and that I might not receive a timely response. + required: true + + - type: textarea + id: summary + attributes: + label: Bug Summary + description: Briefly describe the problem. + validations: + required: false + + - type: input + id: awx-operator-version + attributes: + label: AWX Operator version + description: What version of the AWX Operator are you running? + validations: + required: true + + - type: input + id: awx-version + attributes: + label: AWX version + description: What version of AWX are you running? + validations: + required: true + + - type: dropdown + id: platform + attributes: + label: Kubernetes platform + description: What platform did you install the Operator in? + multiple: false + options: + - kubernetes + - minikube + - openshift + - minishift + - docker development environment + - other (please specify in additional information) + validations: + required: true + + - type: input + id: kube-version + attributes: + label: Kubernetes/Platform version + description: What version of your platform/kuberneties are you using? + validations: + required: true + + - type: dropdown + id: modified-architecture + attributes: + label: Modifications + description: >- + Have you modified the installation, deployment topology, or container images in any way? If yes, please + explain in the "additional information" field at the bottom of the form. + multiple: false + options: + - "no" + - "yes" + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: >- + Starting from a new installation of the system, describe exactly how a developer or quality engineer can reproduce the bug + on infrastructure that isn't yours. Include any and all resources created, input values, test users, roles assigned, playbooks used, etc. + validations: + required: true + + - type: textarea + id: expected-results + attributes: + label: Expected results + description: What did you expect to happpen when running the steps above? + validations: + required: true + + - type: textarea + id: actual-results + attributes: + label: Actual results + description: What actually happened? + validations: + required: true + + - type: textarea + id: additional-information + attributes: + label: Additional information + description: Include any relevant log output, links to sosreport, database dumps, screenshots, AWX spec yaml, or other information. + validations: + required: false + + - type: textarea + id: operator-logs + attributes: + label: Operator Logs + description: Include any relevant logs generated by the operator. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..73e3b11f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +--- +blank_issues_enabled: false +contact_links: + - name: For debugging help or technical support + url: https://github.com/ansible/awx-operator#get-involved + about: For general debugging or technical support please see the Get Involved section of our readme. + - name: 📝 Ansible Code of Conduct + url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser + about: AWX uses the Ansible Code of Conduct; ❤ Be nice to other members of the community. ☮ Behave. + - name: 💼 For Enterprise + url: https://www.ansible.com/products/engine?utm_medium=github&utm_source=issue_template_chooser + about: Red Hat offers support for the Ansible Automation Platform diff --git a/README.md b/README.md index c81e784f9..ec1a65ee9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # AWX Operator -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Build Status](https://github.com/ansible/awx-operator/workflows/CI/badge.svg?event=push)](https://github.com/ansible/awx-operator/actions) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Build Status](https://github.com/ansible/awx-operator/workflows/CI/badge.svg?event=push)](https://github.com/ansible/awx-operator/actions) +[![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-Ansible-yellow.svg)](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) +[![AWX Mailing List](https://img.shields.io/badge/mailing%20list-AWX-orange.svg)](https://groups.google.com/g/awx-project) +[![IRC Chat - #ansible-awx](https://img.shields.io/badge/IRC-%23ansible--awx-blueviolet.svg)](https://libera.chat) An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built with [Operator SDK](https://github.com/operator-framework/operator-sdk) and Ansible. @@ -50,6 +54,8 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w * [Contributing](#contributing) * [Release Process](#release-process) * [Author](#author) + * [Code of Conduct](#code-of-conduct) + * [Get Involved](#get-involved) @@ -1092,3 +1098,15 @@ After the draft release is created, publish it and the [Promote AWX Operator ima ## Author This operator was originally built in 2019 by [Jeff Geerling](https://www.jeffgeerling.com) and is now maintained by the Ansible Team + +## Code of Conduct + +We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com) + +## Get Involved + +We welcome your feedback and ideas. The AWX operator uses the same mailing list and IRC chanel as AWX itself. Here's how to reach us with feedback and questions: + +- Join the `#ansible-awx` channel on irc.libera.chat +- Join the [mailing list](https://groups.google.com/forum/#!forum/awx-project) + diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..2e8815a38 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +For all security related bugs, email security@ansible.com instead of using this issue tracker and you will receive a prompt response. + +For more information on the Ansible community's practices regarding responsible disclosure, see https://www.ansible.com/security