Skip to content
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.

Sign up for GitHub

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

Jump to bottom

added clarification for STATE and STATUS #2843

Merged
merged 5 commits into from
Aug 1, 2023
Merged

added clarification for STATE and STATUS #2843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f49fc18
added draft clarification for STATE and STATUS
ludfjig Jul 28, 2023
f123b17
typo
ludfjig Jul 28, 2023
6757994
added table + css
ludfjig Jul 31, 2023
d061fda
added 1 more table
ludfjig Aug 1, 2023
686c151
Merge branch 'main' into docs-installation
schristoff Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/content/operations/manage-installations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ Installations may be scoped in a namespace, which allows you to group related in
Installation names must be unique within a namespace.
Installations that are not defined in a namespace are considered global, and may be referenced both by other global resources and namespaced resources.

Each installation has an associated **STATE** and **STATUS** field, which can be examined using [porter installation list]. Before an installation is successfully installed, the STATE is initially set to "defined". After successful installation using [porter install], the STATE is changed "installed". Once an installation has been uninstalled using [porter uninstall] the STATUS is set to "uninstalled". The STATUS field reports the result of the latest action, and can be either "succeeded" or "failed". Here are some possible combinations, assuming [porter install] was the latest action:

State | Status | Meaning
--- | --- | --- |
defined | failed | Porter knows about your installation, but failed to install it.
installed | succeeded | Your installation was successfully installed.

Assuming instead [porter uninstall] was the latest action, here are some combinations and their meanings:

State | Status | Meaning
--- | --- | --- |
installed | failed | Porter tried to uninstall your installation, but failed.
uninstalled | succeeded | Your installation was successfully uninstalled.

There are two ways to manage installations: [imperative commands](#imperative-commands) or [desired state](#desired-state).
They are not mutually exclusive, and you can switch back and forth between them at any time.

Expand Down Expand Up @@ -56,5 +70,6 @@ With a GitOps workflow, you define the desired state of your applications and in
[porter installation show]: /cli/porter_installations_show/
[porter install]: /cli/porter_install/
[porter upgrade]: /cli/porter_upgrade/
[porter uninstall]: /cli/porter_uninstall/
[porter installation apply]: /cli/porter_installations_apply/
[Porter Operator]: /operator/
1 change: 1 addition & 0 deletions docs/themes/porter/assets/sass/styles.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ $npm : '../../../../../node_modules';
@import "foundation/components/type.scss";
@import "foundation/components/offcanvas.scss";
@import "foundation/components/visibility.scss";
@import "foundation/components/tables.scss";


// load helm styles
Expand Down
Loading