-
Notifications
You must be signed in to change notification settings - Fork 28
HOLD FOR RELEASE: Add CMX VMs beta docs #3407
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
Open
hyu
wants to merge
20
commits into
main
Choose a base branch
from
cmx-vm-beta
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
fe6b975
Add direct port of VM beta
hyu 492c374
VMs are in Beta
hyu 6f0c43f
Update tone and format for consistenct
hyu 5ee9501
Split up the "Use Compatibility Matrix" page
hyu 94f8991
Reorder sidebar
hyu 3748c27
Clean up VM docs
hyu 2c7fa0d
Restore missing content
hyu 4e3a726
Edit limitations
hyu 89befa3
Split VM docs into 2 pages
hyu 93b9950
Intro note for when to use Clusters vs VMs
hyu 6f0952f
No "CMX" shorthand
hyu 58c4424
Small fixes for Cluster page
hyu 503b3bb
Review VMs page
hyu fc03b4a
Review Cluster and VM create info
hyu 4984433
Read through VM doc
hyu a32257b
Fewer notes
hyu 1ad3a85
edits
paigecalvert 45a6725
edits
paigecalvert 414808b
edits
paigecalvert bf90ee8
edits
paigecalvert 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,29 @@ | ||
import TestRecs from "../partials/ci-cd/_test-recs.mdx" | ||
|
||
# Use Compatibility Matrix with CI/CD | ||
|
||
This topic describes how to integrate Replicated Compatibility Matrix into your CI/CD workflows. | ||
|
||
## About Using Compatibility Matrix with CI/CD | ||
|
||
Replicated recommends that you integrate Compatibility Matrix into your existing CI/CD workflow to automate the process of creating clusters to install your application and run tests. For more information, including additional best practices and recommendations for CI/CD, see [About Integrating with CI/CD](/vendor/ci-overview). | ||
|
||
### Replicated GitHub Actions | ||
|
||
Replicated maintains a set of custom GitHub actions that are designed to replace repetitive tasks related to using Compatibility Matrix and distributing applications with Replicated. | ||
|
||
If you use GitHub Actions as your CI/CD platform, you can include these custom actions in your workflows rather than using Replicated CLI commands. Integrating the Replicated GitHub actions into your CI/CD pipeline helps you quickly build workflows with the required inputs and outputs, without needing to manually create the required CLI commands for each step. | ||
|
||
To view all the available GitHub actions that Replicated maintains, see the [replicatedhq/replicated-actions](https://github.com/replicatedhq/replicated-actions/) repository in GitHub. | ||
|
||
For more information, see [Use Replicated GitHub Actions in CI/CD](/vendor/ci-workflows-github-actions). | ||
|
||
### Recommended Workflows | ||
|
||
Replicated recommends that you maintain unique CI/CD workflows for development (continuous integration) and for releasing your software (continuous delivery). For example development and release workflows that integrate Compatibility Matrix for testing, see [Recommended CI/CD Workflows](/vendor/ci-workflows). | ||
|
||
### Test Script Recommendations | ||
|
||
Incorporating code tests into your CI/CD workflows is important for ensuring that developers receive quick feedback and can make updates in small iterations. Replicated recommends that you create and run all of the following test types as part of your CI/CD workflows: | ||
|
||
<TestRecs/> |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Airgap is referenced here but we never talk about it in the Create VMs page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah yeah I had noticed that too and forgot to remove it. Good catch!