-
Notifications
You must be signed in to change notification settings - Fork 43
Add self-hosting page #897
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
794fdc5
Add self-hosting page.
josh-padnick 483f0fe
Revert index.md
josh-padnick e06d029
Update index.md
josh-padnick 8dfd71c
Relocate self-hosting.md to docs_sources
josh-padnick db7032b
Remove generated file.
josh-padnick 41e1a96
Create self-hosting.md
josh-padnick File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| sidebar_label: "Self-hosting" | ||
| --- | ||
|
|
||
| # Self-hosting the library | ||
|
|
||
| :::caution | ||
|
|
||
| Self-hosting Gruntwork Library is only available with a Gruntwork Enterprise subscription. | ||
|
|
||
| ::: | ||
|
|
||
| We recommend accessing Gruntwork Library directly through our private repos hosted at https://github.com/gruntwork-io. However if your company requires that all Terraform modules are hosted internally, we offer a tool called [repo-copier](https://github.com/gruntwork-io/repo-copier) to support this use case. | ||
|
|
||
| ## What is repo-copier? | ||
|
|
||
| Repo Copier is a CLI tool that copies all the data in our private GitHub repos (including code, GitHub issues, GitHub pull requests, and releases) to a version control system operated by you, the customer. This gives you full access to Gruntwork Library without having to use GitHub.com directly. To learn more, see https://github.com/gruntwork-io/repo-copier. | ||
|
|
||
| ## What version control systems are supported? | ||
|
|
||
| Repo-copier supports copying the Gruntwork repos to your own GitHub.com org, GitHub Enterprise, BitBucket Server, and GitLab.com. We may add support for additional systems in the future. | ||
|
|
||
| ## Can I use Artifactory or Nexus? | ||
|
|
||
| Repo-copier only works with version control systems like GitHub, GitLab, and BitBucket Server. Version control systems include support for not only hosting code, but also issues, pull requests, release tags, and release assets. | ||
|
|
||
| By contrast, artifact management tools like Artifactory or Nexus can store release assets and even support Terraform module registry functionality, however they don't capture all the metadata, such as issues and pull requests that engineers need to gain full value of the code and all the community activity around it. | ||
|
|
||
| ## Can I just fork the repos myself? | ||
|
|
||
| You're welcome to do this, but it doesn't solve the full problem. A fully self-hosted solution must meet all the following requirements: | ||
|
|
||
| - As Gruntwork posts updates, those updates propagate to your hosted version automatically. | ||
| - Your copy must include not only the code, but all the metadata, including issues, pull requests, release tags, and release assets. | ||
| - All internal cross-references to github.com/gruntwork-io must be updated to point to the new hosting URL. | ||
|
|
||
| ## How do I contribute changes back to Gruntwork if I self-host? | ||
|
|
||
| Contribute your changes directly to our GitHub.com repos. Those changes will then propagate back to your locally hosted copy! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| sidebar_label: "Self-hosting" | ||
| --- | ||
|
|
||
| # Self-hosting the library | ||
|
|
||
| :::caution | ||
|
|
||
| Self-hosting Gruntwork Library is only available with a Gruntwork Enterprise subscription. | ||
|
|
||
| ::: | ||
|
|
||
| We recommend accessing Gruntwork Library directly through our private repos hosted at https://github.com/gruntwork-io. However if your company requires that all Terraform modules are hosted internally, we offer a tool called [repo-copier](https://github.com/gruntwork-io/repo-copier) to support this use case. | ||
|
|
||
| ## What is repo-copier? | ||
|
|
||
| Repo Copier is a CLI tool that copies all the data in our private GitHub repos (including code, GitHub issues, GitHub pull requests, and releases) to a version control system operated by you, the customer. This gives you full access to Gruntwork Library without having to use GitHub.com directly. To learn more, see https://github.com/gruntwork-io/repo-copier. | ||
|
|
||
| ## What version control systems are supported? | ||
|
|
||
| Repo-copier supports copying the Gruntwork repos to your own GitHub.com org, GitHub Enterprise, BitBucket Server, and GitLab.com. We may add support for additional systems in the future. | ||
|
|
||
| ## Can I use Artifactory or Nexus? | ||
|
|
||
| Repo-copier only works with version control systems like GitHub, GitLab, and BitBucket Server. Version control systems include support for not only hosting code, but also issues, pull requests, release tags, and release assets. | ||
|
|
||
| By contrast, artifact management tools like Artifactory or Nexus can store release assets and even support Terraform module registry functionality, however they don't capture all the metadata, such as issues and pull requests that engineers need to gain full value of the code and all the community activity around it. | ||
|
|
||
| ## Can I just fork the repos myself? | ||
|
|
||
| You're welcome to do this, but it doesn't solve the full problem. A fully self-hosted solution must meet all the following requirements: | ||
|
|
||
| - As Gruntwork posts updates, those updates propagate to your hosted version automatically. | ||
| - Your copy must include not only the code, but all the metadata, including issues, pull requests, release tags, and release assets. | ||
| - All internal cross-references to github.com/gruntwork-io must be updated to point to the new hosting URL. | ||
|
|
||
| ## How do I contribute changes back to Gruntwork if I self-host? | ||
|
|
||
| Contribute your changes directly to our GitHub.com repos. Those changes will then propagate back to your locally hosted copy! | ||
|
|
||
|
|
||
| <!-- ##DOCS-SOURCER-START | ||
| { | ||
| "sourcePlugin": "local-copier", | ||
| "hash": "50cb24787ac5e5bd1d89e3e452190e6b" | ||
| } | ||
| ##DOCS-SOURCER-END --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.