-
Notifications
You must be signed in to change notification settings - Fork 19
Update docs 003a #859
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
KiraLempereur-Spacelift
wants to merge
27
commits into
main
Choose a base branch
from
update-docs-003a
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.
+371
−510
Open
Update docs 003a #859
Changes from all commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
6d4af32
Update login-policy.md and worker-pools README
KiraLempereur-Spacelift a674b33
Add LaunchPad steps as getting started section and pages
KiraLempereur-Spacelift cbfebc3
Added alt text and altered screenshot
KiraLempereur-Spacelift e2898bc
Still trying to resolve dead link error
KiraLempereur-Spacelift 4f5eba3
Just deleted the image
KiraLempereur-Spacelift b96495e
Fixed dead link in integrations/single-sign-on/README.md
KiraLempereur-Spacelift 8769d84
Update markdown-link-check.json
KiraLempereur-Spacelift 54ad73a
Remove unused assets
KiraLempereur-Spacelift 44f8b98
Minor fixes and edits
KiraLempereur-Spacelift 6970ad1
Merge branch 'main' into update-docs-002
KiraLempereur-Spacelift 5fecdbb
Added link to custom workflow tool page
KiraLempereur-Spacelift 90f4035
Merge branch 'update-docs-002' of https://github.com/spacelift-io/use…
KiraLempereur-Spacelift 80074ee
Fix typos/small issues per review
KiraLempereur-Spacelift d265e90
Fix dead link on Terraform's docs
KiraLempereur-Spacelift 610d8d0
Added feedback.spacelift to link check ignore
KiraLempereur-Spacelift c4a88bf
Several updates to Stacks docs
KiraLempereur-Spacelift dc9c532
Merge branch 'main' into update-docs-003a
KiraLempereur-Spacelift 278dc54
Update cloud providers README
KiraLempereur-Spacelift 59bdad9
Merge branch 'update-docs-003a' of https://github.com/spacelift-io/us…
KiraLempereur-Spacelift edce162
Stack pages updates
KiraLempereur-Spacelift 4abb742
Update cloud providers readme links
KiraLempereur-Spacelift 06277f1
Updated cloud providers readme again
KiraLempereur-Spacelift 407f037
Dead links updates
KiraLempereur-Spacelift e5361fb
Update markdown-link-check.json
KiraLempereur-Spacelift 81e350e
Removed unused assets
KiraLempereur-Spacelift afe8795
Updated stack scheduling page
KiraLempereur-Spacelift c528673
Merge branch 'main' into update-docs-003a
KiraLempereur-Spacelift 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
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-70.6 KB
...sets/screenshots/integrations/cloud-providers/aws/attach-integration-step-1.png
Binary file not shown.
Binary file removed
BIN
-132 KB
...sets/screenshots/integrations/cloud-providers/aws/attach-integration-step-2.png
Binary file not shown.
Binary file removed
BIN
-127 KB
...sets/screenshots/integrations/cloud-providers/aws/attach-integration-step-3.png
Binary file not shown.
Binary file removed
BIN
-184 KB
...sets/screenshots/integrations/cloud-providers/aws/attach-integration-step-4.png
Binary file not shown.
Binary file removed
BIN
-188 KB
docs/assets/screenshots/integrations/cloud-providers/aws/copy-role-arn.png
Binary file not shown.
Binary file removed
BIN
-76.4 KB
docs/assets/screenshots/integrations/cloud-providers/aws/inception-meme.png
Binary file not shown.
Binary file removed
BIN
-19.6 KB
docs/assets/screenshots/integrations/cloud-providers/aws/setup-aws-role.png
Binary file not shown.
Binary file removed
BIN
-146 KB
...ssets/screenshots/integrations/cloud-providers/aws/setup-integration-step-1.png
Diff not rendered.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Diff not rendered.
Diff not rendered.
Oops, something went wrong.
Diff not rendered.
Binary file removed
BIN
-68.4 KB
docs/assets/screenshots/stack/settings/stack-details_set-folder-label.png
Diff not rendered.
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
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 |
---|---|---|
@@ -1,23 +1,26 @@ | ||
# Stack | ||
|
||
_Stack_ is one of the core concepts in Spacelift. A stack is an isolated, independent entity and the choice of the word mirrors products like [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html){: rel="nofollow"}, or [Pulumi](https://www.pulumi.com/docs/intro/concepts/stack/){: rel="nofollow"} (of which we support both). You can think about a stack as a combination of source code, current state of the managed infrastructure (eg. Terraform state file) and configuration in the form of [environment](../configuration/environment.md) variables and mounted files. | ||
If you're managing your infrastructure in Spacelift, you're managing them with stacks. A stack is a combination of source code, the current state of the managed infrastructure (e.g. Terraform state file) and the configuration ([environment](../configuration/environment.md) variables and mounted files). A stack is also an isolated, independent entity. | ||
|
||
Unless you're using Spacelift only to host and test private [Terraform modules](../../vendors/terraform/module-registry.md), your account should probably contain one or more stacks to be of any use. For example: | ||
Unless you're only using Spacelift to host and test private [Terraform modules](../../vendors/terraform/module-registry.md), your account should contain one or more stacks. | ||
|
||
 | ||
 | ||
|
||
Here's a few helpful articles about stacks: | ||
## What can I do with stacks? | ||
|
||
- In [this article](creating-a-stack.md), you can learn how to create a new stack; | ||
- [Here](stack-settings.md) you can see all the settings that are available for the stack; | ||
- [Here](stack-locking.md#stack-locking) you can learn about stack locking; | ||
- [Create, delete, and lock](./creating-a-stack.md) stacks. | ||
- [Organize](./organizing-stacks.md) stacks. | ||
- Configure [stack settings](./stack-settings.md). | ||
- [Schedule](./scheduling.md) stack runs. | ||
- Set up [stack dependencies](./stack-dependencies.md). | ||
- [Detect drift](./drift-detection.md) in managed stacks. | ||
|
||
## Stack state | ||
|
||
Similar to [runs](../run/README.md) and [tasks](../run/task.md), stacks also have states. | ||
A stack's state is the last state of its most recently processed [tracked run](../run/README.md#where-do-runs-come-from) that has progressed beyond the [queued](../run/README.md#queued) state and which was not [canceled](../run/README.md#canceled). | ||
Only if the stack has no runs yet a special state "None" is applied: | ||
Similar to [runs](../run/README.md) and [tasks](../run/task.md), stacks also have states that are generally equal to their most recent [tracked run state](../run/README.md#common-run-states). | ||
|
||
 | ||
The state is set to "None" on stacks with no runs: | ||
|
||
Stack states allow users to see at a glance the overall health of their infrastructure, and the level of development activity associated with it. | ||
 | ||
|
||
Stack states show users the overall health of their infrastructure, and the level of development activity associated with it, at a glance. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,100 +1,106 @@ | ||
# Organizing stacks | ||
# Organize stacks | ||
|
||
Depending on the complexity of your infrastructure, the size of your team, your particular needs and your preferred way of working you may end up managing a lot of stacks. This obviously makes it harder to quickly find what you're looking for. As practitioners ourselves, we're providing you a few tools to make this process more manageable - from the basic [query-based searching](organizing-stacks.md#query-based-searching-and-filtering) to [filtering by status](organizing-stacks.md#label-based-folders) and the coolest of all, [label-based folders](organizing-stacks.md#label-based-folders). | ||
Depending on the complexity of your infrastructure, the size of your team, your particular needs, and your preferred way of working, you may end up managing a lot of stacks. Spacelift offers several options for searching through your stacks, from basic [query-based searching](organizing-stacks.md#query-based-search-and-filter) to [filtering by status](organizing-stacks.md#label-based-folders) and' [label-based folders](organizing-stacks.md#label-based-folders). | ||
|
||
## Video Walkthrough | ||
|
||
<div style="padding:56.25% 0 0 0;position:relative;"><iframe src="https://player.vimeo.com/video/754795106?h=c4e1f101d8&badge=0&autopause=0&player_id=0&app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen style="position:absolute;top:0;left:0;width:100%;height:100%;" title="Organizing a Stack"></iframe></div><script src="https://player.vimeo.com/api/player.js"></script> | ||
|
||
## Customizing table view | ||
## Customize your table view | ||
|
||
Based on the table configuration, you'll be able to customize the view to suit your needs. A settings drawer for customizing the list is available under the icon in the top right corner. | ||
 | ||
You can customize the table view to suit your needs. Click the **Customize list** gear icon at the top-right to open a customizing drawer. | ||
|
||
Clicking the icon opens a drag-and-drop menu where you can hide columns (except for _name_) or rearrange their order: | ||
 | ||
 | ||
 | ||
|
||
To reset your settings, use the _Reset to default_ button located at the bottom of the customization drawer. | ||
1. Drag and drop columns to rearrange or hide them from view. The _name_ column cannot be hidden. | ||
- Alternatively, outside the customize list drawer, hover over the column header and click **Hide**. | ||
 | ||
2. To reset your settings, click **Reset to default** at the bottom of the customization drawer. | ||
|
||
Each column can be resized by dragging the column separator: | ||
 | ||
You can also resize columns in the list by dragging the separator: | ||
 | ||
|
||
Additionally, you can hover over one of the column headers and leverage the dropdown menu to hide them: | ||
 | ||
## Query-based search and filter | ||
|
||
## Query-based searching and filtering | ||
 | ||
|
||
Historically the first tool we offered was the search bar: | ||
You can search and filter by these stack properties in the search bar: | ||
|
||
 | ||
- name | ||
- ID (slug) | ||
- any of its [labels](stack-settings.md#labels) | ||
|
||
The search bar allows you to search and filter by the following stack properties: | ||
## Filter by state | ||
|
||
- name; | ||
- ID (slug); | ||
- any of its [labels](stack-settings.md#labels); | ||
Filtering stacks by state is useful for identifying action items like plans pending confirmation ([unconfirmed](../run/tracked.md#unconfirmed) state) or [failed](../run/README.md#failed) jobs that require fixing. Use the _State_ section on the left-hand sidebar, which displays all states attached to your stacks. Click state checkboxes to filter the list of stacks. | ||
|
||
## Filtering by state | ||
|
||
Filtering stacks by state is a very useful mechanism for identifying action items like plans pending confirmation ([unconfirmed](../run/tracked.md#unconfirmed) state) or [failed](../run/README.md#failed) jobs that require fixing. For that, use the _State_ section on the sidebar to the left. Clicking on any status filters the list of stacks to show only those with the selected status, | ||
|
||
 | ||
|
||
Note that if no stacks in the account have a particular status at the moment, that status is missing from the list. | ||
 | ||
|
||
You can also use our predefined tabs to filter some specific group of states: | ||
 | ||
 | ||
|
||
- Needs Attention: _unconfirmed_ state | ||
- Failed: _failed_ state | ||
- On Hold: _none_, _confirmed_ or _replan-requested_ states | ||
- In progress: _applying_, _destroying_, _initializing_, _planning_, _preparing-apply_ or _preparing-replan_ states | ||
- Finished: _finished_ state | ||
| **Predefined Tab Label** | **State** | | ||
| ----------------------- | --------- | | ||
| Needs Attention | _unconfirmed_ | | ||
| Failed | _failed_ | | ||
| On Hold | _none_, _confirmed_, or _replan-requested_ | | ||
| In Progress | _applying_, _destroying_, _initializing_, _planning_, _preparing-apply_, or _preparing-replan_ | | ||
| Finished | _finished_ | | ||
|
||
## Label-based folders | ||
|
||
Probably the most useful way of grouping stacks is by attaching folder labels to them. You can read more about [labels](stack-settings.md#labels) here, including how to set them, and folder labels are just regular labels, prefixed with `folder:`. In order to make it more obvious in the GUI and save some screen real estate, we replace the `folder:` prefix by the folder icon... | ||
|
||
 | ||
You can group stacks by attaching folder labels to them, which are [regular labels](./stack-settings.md#labels) prefixed with `folder:`. In the stacks list, the `folder:` prefix is replaced width a folder icon. | ||
|
||
...but once you start editing labels, the magic is gone: | ||
 | ||
|
||
 | ||
Your folder labels will appear in the _Folders_ section of the _Filters_ sidebar menu, allowing you to use the checkboxes to filter the list by folder labels. | ||
|
||
For every folder label, a sidebar section is included in the _Folders_ menu, allowing you to search by that label. The number to the right hand side indicates that number of stacks with that label: | ||
|
||
 | ||
 | ||
|
||
### Nesting and multiple folder labels | ||
|
||
Perhaps worth mentioning is the fact that folder labels can be nested, allowing you to create either hierarchies, or arbitrary classifications of your stacks. | ||
Folder labels can be nested, allowing you to create hierarchies or arbitrary classifications of your stacks. | ||
|
||
Also, a single stack can have any number of folder labels set, in which case it belongs to all the collections. In that, folder labels are like labels in Gmail rather than directories in your filesystem. | ||
A single stack can have _any number of folder labels_ set, in which case it belongs to **all** the collections. If you use more than one folder label on a single stack, they act more like labels in e-mail inboxes rather than directories in your filesystem. | ||
|
||
## Saving filters in views | ||
## Save filters in views | ||
|
||
It is possible to save your filters with a Filters Tab. You can select all the filters that you would like to apply, add a search query or sorting in the top right corner, click New View, enter the view name, and click Save. This view is now saved for this account. You can also mark your new view as your default view during creation. Next time you log in or navigate to stacks, your personal default view will be applied. | ||
You can save filter views to easily apply filters to your stacks list. | ||
|
||
 | ||
 | ||
|
||
If you forgot to mark your view as default then you can easily do the same thing in the Views Tab. | ||
1. Select all filters you would like to apply. | ||
2. If desired, add a search query or sorting option in the top-right. | ||
3. Click **New View**, then enter a descriptive name for the filter view. | ||
4. Check the box to set the new view as your default, if desired. | ||
- If you want to edit your default view, click **Views**, click the three dots beside the view name you want to use as default, then click **Use as your default view**. | ||
 | ||
5. Click **Save**. | ||
|
||
 | ||
If you set a filter view as your default, the next time you log in or navigate to the _Stacks_ tab, your personal default view will be applied. | ||
|
||
### Shared views | ||
|
||
Views can be shared or private. While first creating the view, it is available only to your user. If you have admin access, you can make it public for all the users of the account by hovering over the saved view and clicking the small eye icon "Share within account". This way, all the users within this application can see the saved view and who created it. | ||
Filter views can be private (default for new views) or public to all users of the account. To share a filter view, if you are an admin user, click the three dots beside the view name and click **Share within the account**. The view will now be visible for all users within the account. | ||
|
||
### Reset to default view | ||
|
||
### Resetting | ||
To quickly reset your default view to Spacelift's default (no active filters): | ||
|
||
To quickly reset your default view to Spacelift default state, click the "Reset to Spacelift default view" button. It will result in clearing all sorting, search, and filter parameters, as well as managed filter settings. | ||
1. Click **Views** to see your available filter views. | ||
2. Click the three dots beside the view name you're using as default. | ||
3. Click **Reset to Spacelift default view**. | ||
4. All sorting, search, and filter parameters will be cleared. | ||
|
||
 | ||
 | ||
|
||
### Manage view | ||
|
||
- If you change your filter, search and/or sorting settings, you can update the currently selected view by clicking on Update item under "Manage view" button. The blue icon on the manage view button indicates an update possibility. | ||
- Edit name allows editing name of the current view | ||
- Delete allows removing your private view (Shared and Spacelift default views can not be removed). You can delete the view from the Views tab as well. | ||
Manage existing views when you click the three dots next to _New view_. | ||
|
||
- Click **Update** to update your current filter view with any new filters, searches, and/or sorting settings. | ||
- Click **Edit name** to change the name of the current filter view. | ||
- Click **Delete** to remove a private view. If the view has been shared with other users on the account, it cannot be deleted. | ||
|
||
 | ||
 |
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.
Uh oh!
There was an error while loading. Please reload this page.