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

ENDOC-630 add note about attaching cli to ent profile #650

Merged
merged 2 commits into from
Dec 12, 2022
Merged

ENDOC-630 add note about attaching cli to ent profile #650

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0fdcc4
ENDOC-630
Dec 12, 2022
40621c7
ENDOC-630 Add to next/7.1
Dec 12, 2022
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
24 changes: 15 additions & 9 deletions vuepress/docs/next/docs/getting-started/ent-profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,28 @@ At minimum, a profile configuration must consist of the key-value pairs specifyi

Common operations associated with profile management are detailed below.

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 information.
Note: 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 information.

| Command | Description
| :- | :-
| `ent status` | Returns current connection and profile information
| `ent pro new [profileName] [EntandoAppName] [namespace]` | Create and switch to a new profile
| `ent attach-kubeconfig [kubeconfig-file]` | Attach to a kubeconfig
| `ent attach-vm [vm-name]` | Attach to a managed virtual machine
| `ent list-kubectx` | Return a list of Kubernetes contexts
| `ent pro delete [profileName]` | Delete a profile
| `ent pro link [contextName]` | Link the current profile to a Kubernetes context
| `ent pro use [profileName]` | Activate the default profile
| `source ent pro use [profileName]` | Activate the current profile
| `ent pro list` | Print a list of the available profiles
| `ent pro delete [profileName]` | Delete a profile
| `ent pro new [profileName] [EntandoAppName] [namespace]` | Create and switch to a new profile
| `ent pro use [profileName]` | Activate the default profile
| `ent set-kubectl-cmd "[command]" [--kubeconfig=[config]]` | Provide a custom command
| `ent status` | Return current connection and profile information
| `source ent pro use [profileName]` | Activate the current profile

**Command details:**
- `ent pro new`: Sets the minimal profile data and outputs next steps.

- `ent pro link`: Provides ent with instructions to connect to the Kubernetes containing the Entando Application. Alias of `ent attach-kubectx`.

- `ent pro new`: Sets the minimal profile data and outputs next steps.

- `ent pro use`: Initializes the global profile ent should use across shells.

- `source ent pro use`: Initializes the local profile ent should use within the current shell. 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.
Expand All @@ -42,11 +47,12 @@ The output of `ent config` is a key-value archive of configuration settings rela

| Command | Description
| :- | :-
| `ent config --print` | Print the current config archive
| `ent config --edit` | Interactively edit a config archive
| `ent config --get {key}` | Return the value of a config key
| `ent config --print` | Print the current config archive
| `ent config --set {key}` | Delete a config key
| `ent config --set {key} {value}` | Set the value of a config key
| `ent config --set {key}` | Delete a config key


### Keys

Expand Down
2 changes: 1 addition & 1 deletion vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Entando Bundle CLI tool (**ent bundle**) automates many of the tasks involve
* Verify dependencies with the [Entando CLI](../../../docs/getting-started/entando-cli.md#check-the-environment): `ent check-env develop`
* Authenticated Docker credentials
* A Docker repository
* A running Entando instance with your profile attached. To check or configure your profile, see the [ent Profile Management page](../../../docs/getting-started/ent-profile.md).
* A running Entando instance with your profile attached, e.g. use `ent attach-vm YOUR-VM-NAME`. Refer to [Profile and Configuration Management](../../../docs/getting-started/ent-profile.md) for information on connecting to and configuring an instance.
* An Entando project directory. You can create this [from scratch](./publish-simple-bundle.md) or [with the Entando Component Generator](../ms/generate-microservices-and-micro-frontends.md).

## Create and Deploy a Bundle Project
Expand Down