-
Notifications
You must be signed in to change notification settings - Fork 24
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
ent profile edits #537
Merged
Merged
ent profile edits #537
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 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,3 +1,92 @@ | ||
--- | ||
sidebarDepth: 1 | ||
--- | ||
|
||
|
||
# Profile Management | ||
|
||
The [Entando CLI](entando-cli.md) can define a collection of configuration variables to fully describe an Entando instance. One or more profiles can be created to store configuration settings for a particular instance. The `ent profile` command is available to manage and switch between the configurations of different Entando instances. Refer to `ent profile first-use-readme` for additional details. A profile with this information is automatically generated for a quickstart application. | ||
|
||
At minimum, a configuration must consist of the key-value pairs specifying the application name and namespace. To run the application, the Kubernetes connection must also be provided. Cloud Kubernetes tools typically create a Kube context, which can be linked to an Entando profile. An overview of the current connection and profile information is provided via `ent status`. | ||
|
||
The following commands perform common operations associated with profile management. | ||
|
||
## New Profile | ||
|
||
Create and switch to a new profile: | ||
``` | ||
ent pro new [profileName] [EntandoAppName] [namespace] | ||
``` | ||
This sets the minimal profile data and outputs next steps. | ||
|
||
## Link Profile | ||
|
||
Link the current profile to a Kubernetes context (alias of `ent attach-kubectx`): | ||
``` | ||
ent pro link [contextName] | ||
``` | ||
This provides ent with instructions to connect to the Kubernetes containing the Entando Application. | ||
|
||
## Global Profile | ||
|
||
Activate the profile that ent should use across shells: | ||
``` | ||
ent pro use [profileName] | ||
``` | ||
This initializes the profile ent should use by default. | ||
|
||
## Local Profile | ||
|
||
Activate the profile that ent should use within the current shell: | ||
``` | ||
source ent pro use [profileName] | ||
``` | ||
|
||
This allows ent instances in different shells to simultaneously use different Kube contexts, kubeconfigs or custom commands. The quickstart script creates a profile named "qs--{vmname}" that is associated with the Entando Application it generates. | ||
|
||
Print a list of the available profiles: | ||
``` | ||
ent pro list | ||
``` | ||
|
||
## Delete | ||
|
||
Delete a profile: | ||
``` | ||
ent pro delete [profileName] | ||
``` | ||
|
||
### Configuration Management | ||
The output of `ent config` is a key-value archive of configuration settings related to the current profile. | ||
It can serve several purposes, but a few useful commands and keys are listed below. | ||
|
||
#### Commands | ||
Print the current config archive: | ||
``` | ||
ent config --print | ||
``` | ||
Interactively edit a config archive: | ||
``` | ||
ent config --edit | ||
``` | ||
Return the value of a config key: | ||
``` | ||
ent config --get {key} | ||
``` | ||
Set the value of a config key: | ||
``` | ||
ent config --set {key} {value} | ||
``` | ||
Delete a config key: | ||
``` | ||
ent config --set {key} | ||
``` | ||
#### Keys | ||
| Key | Definition | | ||
|---|---| | ||
| ENTANDO_NAMESPACE | stores the fallback namespace used by explicit or implicit runs of `ent kubectl` | | ||
| ENTANDO_APPNAME | stores the Entando Application name related to the current profile | | ||
| DESIGNATED_JAVA_HOME | stores the path of the Java version used internally by ent | | ||
|
||
|
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.
Is the kubernetes connection the same as Kube context? It is confusing,
thinking ent status would be more helpful listed below. Let's discuss
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.
kubernetes connection is the broadest way to describe connecting to k8s, which can be done with a k8s context.
i played with that but it works better in the intro, when k8s connection is introduced. it doesn't follow the same pattern as the commands we spell out in the body of the page.