Merge pull request #650 from entando/ENDOC-630

ENDOC-630 add note about attaching cli to ent profile
entando · Dec 12, 2022 · e50c6c7 · e50c6c7
2 parents eb02f6b + 40621c7
commit e50c6c7
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 22 deletions.
diff --git a/vuepress/docs/next/docs/getting-started/ent-profile.md b/vuepress/docs/next/docs/getting-started/ent-profile.md
@@ -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.
@@ -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
 

diff --git a/vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md b/vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md
@@ -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

diff --git a/vuepress/docs/v7.1/docs/getting-started/ent-profile.md b/vuepress/docs/v7.1/docs/getting-started/ent-profile.md
@@ -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.
@@ -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
 
@@ -55,5 +61,3 @@ The output of `ent config` is a key-value archive of configuration settings rela
 | 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 
-
-
diff --git a/vuepress/docs/v7.1/tutorials/create/pb/publish-project-bundle.md b/vuepress/docs/v7.1/tutorials/create/pb/publish-project-bundle.md
@@ -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