Skip to content

Commit

Permalink
Merge pull request #29 from inspec/doc-updates
Browse files Browse the repository at this point in the history
README improvements and update resource docs to make more accessible.
  • Loading branch information
davymcaleer authored Jun 14, 2018
2 parents 6a6fc22 + 632b612 commit 3e25d2c
Show file tree
Hide file tree
Showing 16 changed files with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,47 @@ $ cat ~/.config/gcloud/application_default_credentials.json
- [Enable Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/)
- [Enable Kubernetes Engine API](https://console.cloud.google.com/apis/library/container.googleapis.com)

## Use the resources

Since this is an InSpec resource pack, it only defines InSpec resources. It includes example tests only. To easily use the GCP resources in your tests do the following:

### Create a new profile

```bash
$ inspec init profile my-profile
```

```yaml
name: my-profile
title: My own Oneview profile
version: 0.1.0
inspec_version: '>= 2.2.10'
depends:
- name: inspec-gcp
url: https://github.com/inspec/inspec-gcp/archive/master.tar.gz
supports:
- platform: gcp
```
## Resource documentation
The following resources are available in the InSpec GCP Profile
- [google_project_iam_custom_role](docs/resources/google_project_iam_custom_role.md)
- [google_compute_instance](docs/resources/google_compute_instance.md)
- [google_service_account](docs/resources/google_service_account.md)
- [google_container_cluster](docs/resources/google_container_cluster.md)
- [google_compute_firewalls](docs/resources/google_compute_firewalls.md)
- [google_project](docs/resources/google_project.md)
- [google_compute_address](docs/resources/google_compute_address.md)
- [google_compute_firewall](docs/resources/google_compute_firewall.md)
- [google_compute_image](docs/resources/google_compute_image.md)
- [google_compute_instance_group](docs/resources/google_compute_instance_group.md)
- [google_compute_zones](docs/resources/google_compute_zones.md)
- [google_compute_zone](docs/resources/google_compute_zone.md)
- [google_compute_instances](docs/resources/google_compute_instances.md)
- [google_storage_bucket](docs/resources/google_storage_bucket.md)
- [google_container_node_pool](docs/resources/google_container_node_pool.md)
## Test inspec-gcp resources
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 3e25d2c

Please sign in to comment.