Skip to content

Commit

Permalink
Merge pull request #40 from dell/doc-update
Browse files Browse the repository at this point in the history 
Updated documentation
  • Loading branch information
@Sakshi-dell
Sakshi-dell authored Feb 24, 2023
2 parents 02fef60 + a7a4a19 commit 8858541
Show file tree
Hide file tree
Showing 10 changed files with 581 additions and 78 deletions.
29 changes: 29 additions & 0 deletions .github/SECURITY.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
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 PowerStore 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](../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 PowerStore maintainers at [email protected].
22 changes: 22 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# v1.0.0
## Release Summary
The release supports resources and data sources mentioned in the Features section for Dell PowerStore.
## Features

### Data Sources:
* `powerstore_volume` for reading volume in PowerStore.

### Resources
* `powerstore_volume` for managing Volume in PowerStore.
* `powerstore_snapshot_rule` for managing Snapshot Rule in PowerStore.
* `powerstore_protection_policy` for managing Protection Policy in PowerStore.
* `powerstore_storage_container` for managing Storage Container in PowerStore.

### Others
N/A

## Enhancements
N/A

## Bug Fixes
N/A
135 changes: 79 additions & 56 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,82 +1,105 @@
<!--
Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
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.
-->
# Terraform Provider for Dell Technologies PowerStore

# Terraform Provider for PowerStore
[![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 PowerStore is a plugin for Terraform that allows the resource management for PowerStore appliance. This provider is built by Dell Technologies CTIO (Chief Technology & Innovation Office) team. For more details on PowerStore, please refer to PowerStore Official webpage [here][powerstore-website].

For general information about Terraform, visit the [official website][tf-website] and the [GitHub project page][tf-github].
The Terraform Provider for Dell Technologies (Dell) PowerStore allows Data Center and IT administrators to use Hashicorp Terraform to automate and orchestrate the provisioning and management of Dell PowerStore storage systems.

[tf-website]: https://terraform.io
[tf-github]: https://github.com/hashicorp/terraform
[powerstore-website]: https://www.delltechnologies.com/en-in/storage/powerstore-storage-appliance.htm
The Terraform Provider can be used to manage volumes, snapshot rules, protection policies and storage containers.

## Requirements
## Table of contents

- [Terraform](https://www.terraform.io/downloads.html) 0.13.x and later
- [Go](https://golang.org/doc/install) 1.13.x and later (to build the provider plugin)
* [License](#license)
* [Prerequisites](#prerequisites)
* [List of Resources in Terraform Provider for Dell PowerStore](#list-of-resources-in-terraform-provider-for-dell-powerstore)
* [List of DataSources in Terraform Provider for Dell PowerStore](#list-of-datasources-in-terraform-provider-for-dell-powerstore)
* [Releasing, Maintenance and Deprecation](#releasing-maintenance-and-deprecation)

## Development
## License
The Terraform Provider for PowerStore is released and licensed under the MPL-2.0 license. See [LICENSE](https://github.com/dell/terraform-provider-powerstore/blob/main/LICENSE) for the full terms.

*Note*: This project uses [Go modules](https://blog.golang.org/using-go-modules) making it safe to work with it outside of your existing [GOPATH](http://golang.org/doc/code.html#GOPATH). We assuming the dir you choose is in variable $DIR
## Prerequisites

### steps
| **Terraform Provider** | **PowerStore Version** | **OS** | **Terraform** | **Golang**
|---------------------|-----------------------|-------|--------------------|--------------------------|
| v1.0.0 | 3.0 | Ubuntu 22.04 <br> RHEL 8.x <br> RHEL 7.x | 1.3.2 <br> 1.2.9 <br> | 1.19.x

1. clone repo and build the provider binary
```bash
$ mkdir -p $DIR && cd $DIR
$ git clone https://github.com/dell/terraform-provider-powerstore.git
$ go mod download
$ go build
```
## List of Resources in Terraform Provider for Dell PowerStore
* Volume
* Snapshot Rule
* Protection Policy
* Storage Container

2. configure terraform to use this new build provider binary instead of fetching from [terraform registry](https://registry.terraform.io/)
1. create a file `.terraformrc` in home directory and copy the following content
2. replace DIR_absolute_path with the $DIR content i.e. the absolute path where repo is cloned
## List of DataSources in Terraform Provider for Dell PowerStore
* Volume

```bash
$ cat ~/.terraformrc
provider_installation {
## Installation of Terraform Provider for Dell PowerFStore

dev_overrides {
"powerstore.com/powerstoreprovider/powerstore" = "DIR_absolute_path"
}
## Installation from Terraform Registry

The provider will be fetched from the Terraform registry and installed by Terraform automatically.
Create a file called `main.tf` in your workspace with the following contents

direct {}
```terraform
terraform {
required_providers {
powerstore = {
version = "1.0.0"
source = "registry.terraform.io/dell/powerstore"
}
}
}
```

3. run example
```bash
$ cd $DIR/examples
# create a .auto.tfvars file with variables and value
# this var file will be auto loaded
$ cat $DIR/examples/.auto.tfvars
username=""
password=""
endpoint=""
$ terraform apply
...
^C
Then, in that workspace, run
```

4. for debugging
```bash
export TF_LOG_PATH=/tmp/logfile
export GOPOWERSTORE_DEBUG="TRUE"
export TF_LOG="debug"
terraform init
```

## Documentation
## Installation from source code

The documentation for the provider resources can found [here](https://github.com/dell/terraform-provider-powerstore/tree/main/docs/resources)

## Roadmap
Dependencies: Go 1.19.x, make, Terraform 1.2.9/1.3.2
<br>
<br>
Run
```
git clone https://github.com/dell/terraform-provider-powerstore.git
cd terraform-provider-powerstore
make install
```
Then follow [installation from Terraform registry](#installation-from-terraform-registry)

Our roadmap for Terraform provider for PowerStore resources can be found [here](https://github.com/dell/terraform-provider-powerstore/tree/main/docs/ROADMAP.md)
## SSL Certificate Verification

## Contributing
For SSL verifcation on RHEL, these steps can be performed:
* Copy the CA certificate to the `/etc/pki/ca-trust/source/anchors` path of the host by any external means.
* Import the SSL certificate to host by running
```
update-ca-trust extract
```
For SSL verification on Ubuntu, these steps can be performed:
* Copy the CA certificate to the `/etc/ssl/certs` path of the host by any external means.
* Import the SSL certificate to host by running:
```
update-ca-certificates
```

The Terraform PowerStore provider is open-source and community supported.
## Releasing, Maintenance and Deprecation

For issues, questions or feedback, join the [Dell EMC Automation community](https://www.dell.com/community/Automation/bd-p/Automation).
Terraform Provider for Dell Technnologies PowerStore follows [Semantic Versioning](https://semver.org/).

New version will be released regularly if significant changes(bug fixes or new features) are made in the provider.

Released code versions are located on tags with names of the form "vx.y.z" where x.y.z corresponds to the version number.
144 changes: 144 additions & 0 deletions about/CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
<!--
Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
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

## Our pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [email protected]
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary ban

**Community impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent ban

**Community impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
Loading

0 comments on commit 8858541

Please sign in to comment.