https://github.com/massdriver-cloud/azure-vpn-gateway
https://github.com/massdriver-cloud/azure-vpn-gateway
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/massdriver-cloud/azure-vpn-gateway
- Owner: massdriver-cloud
- Created: 2023-11-06T22:57:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-26T16:05:10.000Z (9 months ago)
- Last Synced: 2025-01-23T03:13:47.459Z (5 months ago)
- Language: HCL
- Homepage: https://massdriver.cloud
- Size: 38.1 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Massdriver][logo]][website]
# azure-vpn-gateway
[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
Azure VPN Gateway is a service that uses a specific type of virtual network gateway to send encrypted traffic between an Azure virtual network and on-premises locations over the public Internet.
---
## Design
For detailed information, check out our [Operator Guide](operator.md) for this bundle.
## Usage
Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.
### What are Bundles?
Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).
## Bundle
### Params
Form input parameters for configuring a bundle for deployment.
View
## Properties
- **`gateway`** *(object)*: **Provisioning of the VPN Gateway takes approximately 30-60 minutes.**.
- **`auth_type`** *(string)*: The authentication type to use for the VPN connection. **If using Microsoft Entra ID, be sure to authorize the Azure VPN app in your Azure account [here](https://login.microsoftonline.com/common/oauth2/authorize?client_id=41b23e61-6c1e-4545-b367-cd054e0ed4b4&response_type=code&redirect_uri=https://portal.azure.com&nonce=1234&prompt=admin_consent).** The authentication type **cannot be changed** after deployment.
- **One of**
- Microsoft Entra ID
- **`generation`** *(string)*: The generation for the VPN gateway. [Learn more](https://learn.microsoft.com/en-us/azure/vpn-gateway/vpn-gateway-about-vpn-gateway-settings#gateway-sku-by-performance). Must be one of: `['Generation1', 'Generation2']`.
- **`network`** *(object)*
- **`auto`** *(boolean)*: Enabling this will automatically select an available CIDR range for your database. Unchecking will require you to specify the CIDR. Default: `True`.
### Connections
Connections from other bundles that this bundle depends on.
View
## Properties
- **`azure_service_principal`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`client_id`** *(string)*: A valid UUID field.
Examples:
```json
"123xyz99-ab34-56cd-e7f8-456abc1q2w3e"
```
- **`client_secret`** *(string)*
- **`subscription_id`** *(string)*: A valid UUID field.
Examples:
```json
"123xyz99-ab34-56cd-e7f8-456abc1q2w3e"
```
- **`tenant_id`** *(string)*: A valid UUID field.
Examples:
```json
"123xyz99-ab34-56cd-e7f8-456abc1q2w3e"
```
- **`specs`** *(object)*
- **`azure_virtual_network`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`infrastructure`** *(object)*
- **`cidr`** *(string)*
Examples:
```json
"10.100.0.0/16"
```
```json
"192.24.12.0/22"
```
- **`default_subnet_id`** *(string)*: Azure Resource ID.
Examples:
```json
"/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
```
- **`id`** *(string)*: Azure Resource ID.
Examples:
```json
"/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
```
- **`specs`** *(object)*
- **`azure`** *(object)*: .
- **`region`** *(string)*: Select the Azure region you'd like to provision your resources in.
### Artifacts
Resources created by this bundle that can be connected to other bundles.
View
## Properties
## Contributing
### Bug Reports & Feature Requests
Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/azure-vpn-gateway/issues) to report any bugs or request additional features.
### Developing
**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.
Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).
### Fix or Fork
If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!
## Connect
Questions? Concerns? Adulations? We'd love to hear from you!
Please connect with us!
[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]
[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=azure-vpn-gateway&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=azure-vpn-gateway&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=azure-vpn-gateway&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=azure-vpn-gateway&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=azure-vpn-gateway&utm_content=linkedin
[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/azure-vpn-gateway.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/azure-vpn-gateway/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/azure-vpn-gateway.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/azure-vpn-gateway/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/azure-vpn-gateway.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/azure-vpn-gateway/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/azure-vpn-gateway.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/azure-vpn-gateway/issues
[release_url]: https://github.com/massdriver-cloud/azure-vpn-gateway/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/azure-vpn-gateway.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/azure-vpn-gateway.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/azure-vpn-gateway/blob/main/LICENSE
[email_url]: mailto:[email protected]
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:[email protected]
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=azure-vpn-gateway&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=azure-vpn-gateway&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500