Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.

Commit

Permalink
Convert all relative links to absolute links.
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-padnick committed Sep 16, 2017
1 parent fef5c36 commit facaacc
Show file tree
Hide file tree
Showing 14 changed files with 90 additions and 90 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ We also recommend updating the automated tests *before* updating any code (see [
Development](https://en.wikipedia.org/wiki/Test-driven_development)). That means you add or update a test case,
verify that it's failing with a clear error message, and *then* make the code changes to get that test to pass. This
ensures the tests stay up to date and verify all the functionality in this Blueprint, including whatever new
functionality you're adding in your contribution. Check out the [tests](/tests) folder for instructions on running the
functionality you're adding in your contribution. Check out the [tests](https://github.com/hashicorp/terraform-google-vault/tree/master/tests) folder for instructions on running the
automated tests.

## Update the code
Expand Down
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,37 @@ secrets. This Module uses [GCS](https://cloud.google.com/storage/) as a [storage
https://www.vaultproject.io/docs/configuration/storage/index.html) and a [Consul](https://www.consul.io)
server cluster as a [high availability backend](https://www.vaultproject.io/docs/concepts/ha.html):

![Vault architecture](/_docs/architecture.png)
![Vault architecture](https://github.com/hashicorp/terraform-google-vault/blob/master/_docs/architecture.png?raw=true)

This Module includes the following submodules:

* [install-vault](/modules/install-valut): This module can be used to install Vault. It can be used in a
* [install-vault](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/install-valut): This module can be used to install Vault. It can be used in a
[Packer](https://www.packer.io/) template to create a Vault
[Google Image](https://cloud.google.com/compute/docs/images).

* [run-vault](/modules/run-vault): This module can be used to configure and run Vault. It can be used in a
* [run-vault](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/run-vault): This module can be used to configure and run Vault. It can be used in a
[Startup Script](https://cloud.google.com/compute/docs/startupscript)
to fire up Vault while the server is booting.

* [install-nginx](/modules/install-valut): This module can be used to install Nginx. It can be used in a
* [install-nginx](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/install-valut): This module can be used to install Nginx. It can be used in a
[Packer](https://www.packer.io/) template to create a Vault
[Google Image](https://cloud.google.com/compute/docs/images). This module is only necessary when using
a Load Balancer which requires a Health Checker.

* [run-nginx](/modules/run-vault): This module can be used to configure and run nginx. It can be used in a
* [run-nginx](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/run-vault): This module can be used to configure and run nginx. It can be used in a
[Startup Script](https://cloud.google.com/compute/docs/startupscript)
to launch nginx while the server is booting.

* [vault-cluster](/modules/vault-cluster): Terraform code to deploy a cluster of Vault servers using a [Managed Instance
* [vault-cluster](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster): Terraform code to deploy a cluster of Vault servers using a [Managed Instance
Group](https://cloud.google.com/compute/docs/instance-groups/).

* [vault-lb-fr](/modules/vault-elb): Configures a [Regional External Load Balancer](https://cloud.google.com/compute/docs/load-balancing/)
* [vault-lb-fr](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-elb): Configures a [Regional External Load Balancer](https://cloud.google.com/compute/docs/load-balancing/)
in front of Vault if you need to access it from the public Internet.

* [private-tls-cert](/modules/private-tls-cert): Generate a private TLS certificate for use with a private Vault
* [private-tls-cert](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/private-tls-cert): Generate a private TLS certificate for use with a private Vault
cluster.

* [update-certificate-store](/modules/update-certificate-store): Add a trusted, CA public key to an OS's
* [update-certificate-store](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/update-certificate-store): Add a trusted, CA public key to an OS's
certificate store. This allows you to establish TLS connections to services that use this TLS certs signed by this
CA without getting x509 certificate errors.

Expand Down Expand Up @@ -68,9 +68,9 @@ Gruntwork can help with:
This Module adheres to [Terraform Module Conventions](https://www.terraform.io/docs/modules/index.html) and has the
following folder structure:

* [modules](/modules): This folder contains the reusable code for this Terraform Module, broken down into one or more submodules.
* [examples](/examples): This folder contains examples of how to use the submodules.
* [test](/test): Automated tests for the submodules and examples.
* [modules](https://github.com/hashicorp/terraform-google-vault/tree/master/modules): This folder contains the reusable code for this Terraform Module, broken down into one or more submodules.
* [examples](https://github.com/hashicorp/terraform-google-vault/tree/master/examples): This folder contains examples of how to use the submodules.
* [test](https://github.com/hashicorp/terraform-google-vault/tree/master/test): Automated tests for the submodules and examples.

Click on each of the submodules above for more details.

Expand All @@ -82,43 +82,43 @@ To deploy the Consul server cluster, use the [Consul GCP Module](https://github.

To deploy the Vault cluster:

1. Create a Google Image that has Vault installed (using the [install-vault module](/modules/install-vault)) and the Consul
1. Create a Google Image that has Vault installed (using the [install-vault module](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/install-vault)) and the Consul
agent installed (using the [install-consul
module](https://github.com/gruntwork-io/terraform-google-consul/tree/master/modules/install-consul)). Here is an
[example Packer template](/examples/vault-consul-image). Google Cloud does not allow the creation of public Images
[example Packer template](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-consul-image). Google Cloud does not allow the creation of public Images
so you _must_ create this Image on your own to proceed!

1. Deploy that Image across a Managed Instance Group using the Terraform [vault-cluster-module](/modules/vault-cluster).
1. Deploy that Image across a Managed Instance Group using the Terraform [vault-cluster-module](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster).

1. Execute the [run-consul script](https://github.com/gruntwork-io/terraform-google-consul/tree/master/modules/run-consul)
with the `--client` flag during boot on each Instance to have the Consul agent connect to the Consul server cluster.

1. Execute the [run-vault](/modules/run-vault) script during boot on each Instance to create the Vault cluster.
1. Execute the [run-vault](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/run-vault) script during boot on each Instance to create the Vault cluster.

1. If you only need to access Vault from inside your GCP account (recommended), run the [install-dnsmasq
module](https://github.com/gruntwork-io/terraform-google-consul/tree/master/modules/install-dnsmasq) on each server,
and that server will be able to reach Vault using the Consul Server cluster as the DNS resolver (e.g. using an address
like `vault.service.consul`). See the [vault-cluster-private example](/examples/vault-cluster-private) for working
like `vault.service.consul`). See the [vault-cluster-private example](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-cluster-private) for working
sample code.

1. If you need to access Vault from the public Internet, deploy the [vault-lb-fr module](/modules/vault-lb-fr) and have
all requests to Vault go through the Load Balancer. See the [vault-cluster-public example](/examples/vault-cluster-public)
1. If you need to access Vault from the public Internet, deploy the [vault-lb-fr module](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-lb-fr) and have
all requests to Vault go through the Load Balancer. See the [vault-cluster-public example](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-cluster-public)
for working sample code.

1. Head over to the [How do you use the Vault cluster?](/modules/vault-cluster#how-do-you-use-the-vault-cluster) guide
1. Head over to the [How do you use the Vault cluster?](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster#how-do-you-use-the-vault-cluster) guide
to learn how to initialize, unseal, and use Vault.



## Quick Start

See the [root-example](/examples/root-example) for the fastest way to try out this Module.
See the [root-example](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/root-example) for the fastest way to try out this Module.



## How do I contribute to this Module?

Contributions are very welcome! Check out the [Contribution Guidelines](/CONTRIBUTING.md) for instructions.
Contributions are very welcome! Check out the [Contribution Guidelines](https://github.com/hashicorp/terraform-google-vault/tree/master/CONTRIBUTING.md) for instructions.



Expand All @@ -135,7 +135,7 @@ MINOR, and PATCH versions on each release to indicate any incompatibilities.

## License

This code is released under the Apache 2.0 License. Please see [LICENSE](/LICENSE) and [NOTICE](/NOTICE) for more
This code is released under the Apache 2.0 License. Please see [LICENSE](https://github.com/hashicorp/terraform-google-vault/tree/master/LICENSE) and [NOTICE](https://github.com/hashicorp/terraform-google-vault/tree/master/NOTICE) for more
details.

Copyright © 2017 Gruntwork, Inc.
Expand Down
14 changes: 7 additions & 7 deletions examples/root-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
This folder contains files for the example Terraform configuration contained in the "root" of this repo.

That example deploys a publicly accessible [Vault](https://www.vaultproject.io/) cluster in [GCP](https://cloud.google.com/)
using the [vault-cluster](/modules/vault-cluster) module. For an example of a private Vault cluster that is accessible
only from inside the Google Cloud VPC, see [vault-cluster-private](/examples/vault-cluster-private). **Do NOT use this
using the [vault-cluster](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster) module. For an example of a private Vault cluster that is accessible
only from inside the Google Cloud VPC, see [vault-cluster-private](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-cluster-private). **Do NOT use this
example in a production setting. Deploying Vault as a publicly accessible cluster is not recommended in production; we
do it here only to provide a convenient quick start experience.**.

Expand All @@ -13,17 +13,17 @@ Consul server cluster using the [consul-cluster module](
https://github.com/gruntwork-io/terraform-google-consul/tree/master/modules/consul-cluster) from the Consul GCP Module.

You will need to create a [Google Image](https://cloud.google.com/compute/docs/images) that has Vault and Consul
installed, which you can do using the [vault-consul-image example](/examples/vault-consul-image)).
installed, which you can do using the [vault-consul-image example](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-consul-image)).

For more info on how the Vault cluster works, check out the [vault-cluster](/modules/vault-cluster) documentation.
For more info on how the Vault cluster works, check out the [vault-cluster](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster) documentation.


## Quick start

To deploy a Vault Cluster:

1. `git clone` this repo to your computer.
1. Build a Vault and Consul Google Image. See the [vault-consul-image example](/examples/vault-consul-image) documentation
1. Build a Vault and Consul Google Image. See the [vault-consul-image example](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-consul-image) documentation
for instructions. Make sure to note down the ID of the Google Image.
1. Install [Terraform](https://www.terraform.io/).
1. Make sure you local environment is authenticated to Google Cloud.
Expand All @@ -32,9 +32,9 @@ To deploy a Vault Cluster:
1. Run `terraform init`.
1. Run `terraform plan`.
1. If the plan looks good, run `terraform apply`.
1. Run the [vault-examples-helper.sh script](/examples/vault-examples-helper/vault-examples-helper.sh) to
1. Run the [vault-examples-helper.sh script](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-examples-helper/vault-examples-helper.sh) to
print out the names and IP addresses of the Vault servers and some example commands you can run to interact with the
cluster: `../vault-examples-helper/vault-examples-helper.sh`.

To see how to connect to the Vault cluster, initialize it, and start reading and writing secrets, head over to the
[How do you use the Vault cluster?](/modules/vault-cluster#how-do-you-use-the-vault-cluster) docs.
[How do you use the Vault cluster?](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster#how-do-you-use-the-vault-cluster) docs.
12 changes: 6 additions & 6 deletions examples/vault-cluster-private/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Private Vault Cluster Example

This example deploys a private [Vault](https://www.vaultproject.io/) cluster in [GCP](https://cloud.google.com/)
using the [vault-cluster](/modules/vault-cluster) module. For an example of a public Vault cluster that is accessible
from the public Internet, see [vault-cluster-public](/examples/vault-cluster-public). A private Vault cluster is only
using the [vault-cluster](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster) module. For an example of a public Vault cluster that is accessible
from the public Internet, see [vault-cluster-public](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-cluster-public). A private Vault cluster is only
reachable from another Compute Instance, so this example does not provide any built-in way of reaching the Compute
Instances that are launched. Instead, you will need to separately launch a public Compute Instance from which you can
access these nodes.
Expand All @@ -12,17 +12,17 @@ Consul server cluster using the [consul-cluster module](
https://github.com/gruntwork-io/terraform-google-consul/tree/master/modules/consul-cluster) from the Consul GCP Module.

You will need to create a [Google Image](https://cloud.google.com/compute/docs/images) that has Vault and Consul
installed, which you can do using the [vault-consul-image example](/examples/vault-consul-image)).
installed, which you can do using the [vault-consul-image example](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-consul-image)).

For more info on how the Vault cluster works, check out the [vault-cluster](/modules/vault-cluster) documentation.
For more info on how the Vault cluster works, check out the [vault-cluster](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster) documentation.


## Quick start

To deploy a Vault Cluster:

1. `git clone` this repo to your computer.
1. Build a Vault and Consul Google Image. See the [vault-consul-image example](/examples/vault-consul-image) documentation
1. Build a Vault and Consul Google Image. See the [vault-consul-image example](https://github.com/hashicorp/terraform-google-vault/tree/master/examples/vault-consul-image) documentation
for instructions. Make sure to note down the ID of the Google Image.
1. Install [Terraform](https://www.terraform.io/).
1. Make sure you local environment is authenticated to Google Cloud.
Expand All @@ -36,4 +36,4 @@ To deploy a Vault Cluster:
within the VPC, modify the `allowed_inbound_cidr_blocks_api` variable.

To see how to connect to the Vault cluster, initialize it, and start reading and writing secrets, head over to the
[How do you use the Vault cluster?](/modules/vault-cluster#how-do-you-use-the-vault-cluster) docs.
[How do you use the Vault cluster?](https://github.com/hashicorp/terraform-google-vault/tree/master/modules/vault-cluster#how-do-you-use-the-vault-cluster) docs.
Loading

0 comments on commit facaacc

Please sign in to comment.