diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 4873f938..1cc2b5fe 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -6,17 +6,24 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. --> # Security policy The Terraform Provider for Dell PowerFlex repository is inspected for security vulnerabilities via blackduck scans and static code analysis. -In addition to this, there are various security checks that get executed against a branch when a pull request is created/updated. Please refer to [pull request](https://github.com/dell/terraform-provider-powerflex/blob/main/CONTRIBUTING.md#Pull-requests) for more information. +In addition to this, there are various security checks that get executed against a branch when a pull request is created/updated. Please refer to [pull request](../about/CONTRIBUTING.md#Pull-requests) for more information. ## Reporting a vulnerability Have you discovered a security vulnerability in this project? We ask you to alert the maintainers by sending an email, describing the issue, impact, and fix - if applicable. -You can reach the Terraform providers for Dell PowerFlex maintainers at ses.avengers@dell.com. +You can reach the Terraform providers for Dell PowerFlex maintainers at tpfdi.team@dell.com. diff --git a/README.md b/README.md index cb4706fd..60381795 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ + # Terraform Provider for Dell Technologies PowerFlex +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](about/CODE_OF_CONDUCT.md) +[![License](https://img.shields.io/badge/License-MPL_2.0-blue.svg)](LICENSE) + The Terraform Provider for Dell Technologies (Dell) PowerFlex allows Data Center and IT administrators to use Hashicorp Terraform to automate and orchestrate the provisioning and management of Dell PowerFlex storage systems. The Terraform Provider can be used to manage SDCs, volumes, snapshots, snapshot-policies, storage pools, SDSs and protection domains. ## Table of contents -* [Support](https://github.com/dell/terraform-provider-powerflex/blob/main/about/SUPPORT.md) +* [Support](about/SUPPORT.md) * [License](#license) * [Prerequisites](#prerequisites) * [List of DataSources in Terraform Provider for Dell PowerFlex](#list-of-datasources-in-terraform-provider-for-dell-powerflex) @@ -14,7 +33,7 @@ The Terraform Provider can be used to manage SDCs, volumes, snapshots, snapshot- * [Releasing, Maintenance and Deprecation](#releasing-maintenance-and-deprecation) ## License -The Terraform Provide for PowerFlex is released and licensed under the MPL-2.0 license. See [LICENSE](https://github.com/dell/terraform-provider-powerflex/blob/main/LICENSE) for the full terms. +The Terraform Provide for PowerFlex is released and licensed under the MPL-2.0 license. See [LICENSE](LICENSE) for the full terms. ## Prerequisites @@ -23,22 +42,22 @@ The Terraform Provide for PowerFlex is released and licensed under the MPL-2.0 l | v1.0.0 | 3.6 | ubuntu22.04
rhel8.x
rhel7.x | 1.3.2
1.2.9
| 1.19.x ## List of DataSources in Terraform Provider for Dell PowerFlex - * [SDC](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/sdc.md) - * [Storage pool](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/storagepool.md) - * [Volume](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/volume.md) - * [SDS](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/sds.md) - * [Protection Domain](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/protection_domain.md) - * [Snapshot Policy](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/data-sources/protection_domain.md) + * [SDC](docs/data-sources/sdc.md) + * [Storage pool](docs/data-sources/storagepool.md) + * [Volume](docs/data-sources/volume.md) + * [SDS](docs/data-sources/sds.md) + * [Protection Domain](docs/data-sources/protection_domain.md) + * [Snapshot Policy](docs/data-sources/protection_domain.md) ## List of Resources in Terraform Provider for Dell PowerFlex - * [SDC](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/sdc.md) - * [Storage pool](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/storagepool.md) - * [Volume](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/volume.md) - * [SDS](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/sds.md) - * [Snapshot](https://github.com/dell/terraform-provider-powerflex/blob/main/docs/resources/snapshot.md) + * [SDC](docs/resources/sdc.md) + * [Storage pool](docs/resources/storagepool.md) + * [Volume](docs/resources/volume.md) + * [SDS](docs/resources/sds.md) + * [Snapshot](docs/resources/snapshot.md) ## Installation and execution of Terraform Provider for Dell PowerFlex -The installation and execution steps of Terraform Provider for Dell PowerFlex can be found [here](https://github.com/dell/terraform-provider-powerflex/blob/main/about/INSTALLATION.md). +The installation and execution steps of Terraform Provider for Dell PowerFlex can be found [here](about/INSTALLATION.md). ## Releasing, Maintenance and Deprecation diff --git a/about/CODE_OF_CONDUCT.md b/about/CODE_OF_CONDUCT.md index d3c8886e..04d58ecd 100644 --- a/about/CODE_OF_CONDUCT.md +++ b/about/CODE_OF_CONDUCT.md @@ -6,6 +6,13 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. --> # Code of conduct - contributor covenant diff --git a/about/COMMITTER_GUIDE.md b/about/COMMITTER_GUIDE.md index da263fd6..370f2cc4 100644 --- a/about/COMMITTER_GUIDE.md +++ b/about/COMMITTER_GUIDE.md @@ -6,6 +6,13 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. --> # Committer guidelines diff --git a/about/CONTRIBUTING.md b/about/CONTRIBUTING.md index 60013840..58b0a702 100644 --- a/about/CONTRIBUTING.md +++ b/about/CONTRIBUTING.md @@ -6,11 +6,18 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. --> # How to contribute -Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](https://github.com/dell/terraform-provider-powerflex/blob/main/CODE_OF_CONDUCT.md). +Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). ## Table of contents @@ -36,15 +43,15 @@ You can contribute to this project in several ways. Here are some examples: ## Submitting issues -All issues related to Terraform provider for Dell PowerFlex, regardless of the service/repository the issue belongs to (see table above), should be submitted [here](https://github.com/dell/terraform-provider-powerflex/issues). Issues will be triaged and labels will be used to indicate the type of issue. This section outlines the types of issues that can be submitted. +All issues related to Terraform provider for Dell PowerFlex, regardless of the service/repository the issue belongs to (see table above), should be submitted [here](https://github.com/dell/dell-terraform-providers/issues). Issues will be triaged and labels will be used to indicate the type of issue. This section outlines the types of issues that can be submitted. ### Report bugs We aim to track and document everything related to Terraform provider for Dell PowerFlex via the Issues page. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process. -Before submitting a new issue, make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/dell/terraform-provider-powerflex/issues) for similar issues. +Before submitting a new issue, make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/dell/dell-terraform-providers/issues) for similar issues. -Report a bug by submitting a [bug report](https://github.com/dell/terraform-provider-powerflex/issues/new?labels=type%2Fbug%2C+needs-triage&template=bug_report.md&title=%5BBUG%5D%3A). Make sure that you provide as much information as possible on how to reproduce the bug. +Report a bug by submitting a [bug report](https://github.com/dell/dell-terraform-providers/issues/new?labels=type%2Fbug%2C+needs-triage&template=bug_report.md&title=%5BBUG%5D%3A). Make sure that you provide as much information as possible on how to reproduce the bug. When opening a Bug please include this information to help with debugging: @@ -57,11 +64,11 @@ An Issue __must__ be created before submitting any pull request. Any pull reques ### Feature request -If you have an idea of how to improve this project, submit a [feature request](https://github.com/dell/terraform-provider-powerflex/issues/new?labels=type%2Ffeature-request%2C+needs-triage&template=feature_request.md&title=%5BFEATURE%5D%3A). +If you have an idea of how to improve this project, submit a [feature request](https://github.com/dell/dell-terraform-providers/issues/new?labels=type%2Ffeature-request%2C+needs-triage&template=feature_request.md&title=%5BFEATURE%5D%3A). ### Answering questions -If you have a question and you can't find the answer in the documentation or issues, the next step is to submit a [question.](https://github.com/dell/terraform-provider-powerflex/issues/new?labels=type%2Fquestion&template=ask-a-question.md&title=%5BQUESTION%5D%3A) +If you have a question and you can't find the answer in the documentation or issues, the next step is to submit a [question.](https://github.com/dell/dell-terraform-providers/issues/new?labels=type%2Fquestion&template=ask-a-question.md&title=%5BQUESTION%5D%3A) We'd love your help answering questions being asked by other Terraform provider for Dell PowerFlex users. @@ -76,14 +83,14 @@ Triage helps ensure that issues resolve quickly by: If you don't have the knowledge or time to code, consider helping with _issue triage_. The Terraform provider for Dell PowerFlex community will thank you for saving them time by spending some of yours. -Read more about the ways you can [Triage issues](https://github.com/dell/terraform-provider-powerflex/blob/main/ISSUE_TRIAGE.md). +Read more about the ways you can [Triage issues](ISSUE_TRIAGE.md). ## Your first contribution Unsure where to begin contributing? Start by browsing issues labeled `beginner friendly` or `help wanted`. -* [Beginner-friendly](https://github.com/dell/terraform-provider-powerflex/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) issues are generally straightforward to complete. -* [Help wanted](https://github.com/dell/terraform-provider-powerflex/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues are problems we would like the community to help us with regardless of complexity. +* [Beginner-friendly](https://github.com/dell/dell-terraform-providers/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) issues are generally straightforward to complete. +* [Help wanted](https://github.com/dell/dell-terraform-providers/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues are problems we would like the community to help us with regardless of complexity. When you're ready to contribute, it's time to create a pull request. @@ -140,7 +147,7 @@ Make sure that the title for your pull request uses the same format as the subje ### Quality gates for pull requests -GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](https://github.com/dell/terraform-provider-powerflex/blob/main/SUPPORT.md). +GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](SUPPORT.md). #### Code sanitization diff --git a/about/INSTALLATION.md b/about/INSTALLATION.md index ecb0f85c..5df59a7a 100644 --- a/about/INSTALLATION.md +++ b/about/INSTALLATION.md @@ -6,6 +6,13 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. --> # Installation of Terraform Provider for Dell PowerFlex diff --git a/about/SUPPORT.md b/about/SUPPORT.md index 639f0228..15c40a0a 100644 --- a/about/SUPPORT.md +++ b/about/SUPPORT.md @@ -6,7 +6,17 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. --> -## Support -For all your support needs you can interact with us on [GitHub](https://github.com/dell/terraform-provider-powerflex) by creating a [GitHub Issue](https://github.com/dell/terraform-provider-powerflex/issues) or by sending email to ses.avengers@dell.com. \ No newline at end of file +# Support + +For all your support needs or to follow the latest ongoing discussions and updates, join our Slack group. Click [Here](./) to request your invite. + +You can also interact with us on [GitHub](https://github.com/dell/dell-terraform-providers) by creating a [GitHub Issue](https://github.com/dell/dell-terraform-providers/issues).