From af4f53bea9aa850011b1648946bf56fc824a7b2b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 22 Nov 2024 17:42:41 +0100 Subject: [PATCH] docs: akka CLI docs (#32) Co-authored-by: GitHub --- Makefile | 2 +- docs/src-static/install-cli.sh | 0 .../reference/pages/cli/akka-cli/akka.adoc | 14 ++++++------- .../pages/cli/akka-cli/akka_auth.adoc | 6 +++--- .../akka_auth_container-registry.adoc | 12 +++++++---- ...container-registry_clear-cached-token.adoc | 2 +- ...kka_auth_container-registry_configure.adoc | 2 +- ...a_auth_container-registry_credentials.adoc | 4 ++-- ...uth_container-registry_install-helper.adoc | 4 ++-- .../pages/cli/akka-cli/akka_auth_signup.adoc | 2 +- .../pages/cli/akka-cli/akka_auth_tokens.adoc | 6 +++++- .../cli/akka-cli/akka_auth_tokens_create.adoc | 2 +- .../cli/akka-cli/akka_auth_tokens_list.adoc | 2 +- .../cli/akka-cli/akka_auth_tokens_revoke.adoc | 2 +- .../pages/cli/akka-cli/akka_config.adoc | 5 ++++- .../cli/akka-cli/akka_config_clear-cache.adoc | 2 +- .../pages/cli/akka-cli/akka_config_clear.adoc | 2 +- .../akka-cli/akka_config_current-context.adoc | 2 +- .../akka-cli/akka_config_delete-context.adoc | 2 +- .../akka_config_get-organization.adoc | 2 +- .../cli/akka-cli/akka_config_get-project.adoc | 2 +- .../pages/cli/akka-cli/akka_config_get.adoc | 2 +- .../akka-cli/akka_config_list-contexts.adoc | 2 +- .../pages/cli/akka-cli/akka_config_list.adoc | 2 +- .../akka-cli/akka_config_rename-context.adoc | 2 +- .../pages/cli/akka-cli/akka_config_set.adoc | 2 +- .../cli/akka-cli/akka_config_use-context.adoc | 2 +- .../cli/akka-cli/akka_container-registry.adoc | 13 +++++++----- .../akka_container-registry_delete-image.adoc | 8 ++++---- .../akka_container-registry_list-images.adoc | 2 +- .../akka_container-registry_list-tags.adoc | 4 ++-- .../akka_container-registry_list.adoc | 2 +- .../akka_container-registry_print.adoc | 2 +- .../akka_container-registry_push.adoc | 12 +++++------ .../pages/cli/akka-cli/akka_docker.adoc | 2 +- .../akka-cli/akka_docker_add-credentials.adoc | 3 ++- .../akka_docker_list-credentials.adoc | 2 +- .../akka_docker_remove-credentials.adoc | 2 +- .../pages/cli/akka-cli/akka_docs.adoc | 2 +- .../pages/cli/akka-cli/akka_local.adoc | 4 ++-- .../cli/akka-cli/akka_local_console.adoc | 2 +- .../cli/akka-cli/akka_local_services.adoc | 6 +++--- .../akka_local_services_components.adoc | 6 +++++- ...a_local_services_components_get-state.adoc | 2 +- ...ocal_services_components_get-workflow.adoc | 2 +- ...local_services_components_list-events.adoc | 2 +- ...ka_local_services_components_list-ids.adoc | 2 +- ...local_services_components_list-timers.adoc | 2 +- .../akka_local_services_components_list.adoc | 2 +- .../akka-cli/akka_local_services_list.adoc | 1 + .../akka-cli/akka_local_services_views.adoc | 4 ++++ .../cli/akka-cli/akka_organizations.adoc | 6 ++++-- .../cli/akka-cli/akka_organizations_auth.adoc | 1 + .../akka_organizations_invitations.adoc | 2 +- ...akka_organizations_invitations_cancel.adoc | 2 +- ...akka_organizations_invitations_create.adoc | 2 +- .../akka_organizations_invitations_list.adoc | 2 +- .../cli/akka-cli/akka_organizations_list.adoc | 2 +- .../pages/cli/akka-cli/akka_projects.adoc | 10 ++++++---- .../cli/akka-cli/akka_projects_delete.adoc | 3 ++- .../pages/cli/akka-cli/akka_projects_get.adoc | 5 +++-- .../akka-cli/akka_projects_observability.adoc | 15 +++++++------- .../akka_projects_observability_apply.adoc | 4 ++-- .../akka_projects_observability_config.adoc | 6 +++--- ..._projects_observability_config_traces.adoc | 4 ++-- .../akka_projects_observability_edit.adoc | 2 +- .../akka_projects_observability_export.adoc | 4 ++-- .../akka_projects_observability_get.adoc | 2 +- .../akka_projects_observability_set.adoc | 12 +++++------ ...ka_projects_observability_set_default.adoc | 6 +++--- ...bservability_set_default_akka-console.adoc | 2 +- ...bservability_set_default_google-cloud.adoc | 2 +- ...ojects_observability_set_default_otlp.adoc | 2 +- ..._observability_set_default_splunk-hec.adoc | 2 +- .../akka_projects_observability_set_logs.adoc | 4 ++-- ...s_observability_set_logs_google-cloud.adoc | 2 +- ..._projects_observability_set_logs_otlp.adoc | 2 +- ...cts_observability_set_logs_splunk-hec.adoc | 2 +- ...ka_projects_observability_set_metrics.adoc | 4 ++-- ...bservability_set_metrics_google-cloud.adoc | 2 +- ...ojects_observability_set_metrics_otlp.adoc | 2 +- ..._observability_set_metrics_prometheus.adoc | 2 +- ..._observability_set_metrics_splunk-hec.adoc | 2 +- ...kka_projects_observability_set_traces.adoc | 4 ++-- ...observability_set_traces_google-cloud.adoc | 2 +- ...rojects_observability_set_traces_otlp.adoc | 2 +- .../akka_projects_observability_unset.adoc | 4 ++-- ..._projects_observability_unset_default.adoc | 2 +- ...kka_projects_observability_unset_logs.adoc | 2 +- ..._projects_observability_unset_metrics.adoc | 2 +- ...a_projects_observability_unset_traces.adoc | 2 +- .../cli/akka-cli/akka_projects_open.adoc | 2 +- .../cli/akka-cli/akka_projects_regions.adoc | 3 ++- .../akka-cli/akka_projects_regions_add.adoc | 2 +- .../akka-cli/akka_projects_regions_list.adoc | 2 +- .../akka_projects_regions_set-primary.adoc | 2 +- .../cli/akka-cli/akka_projects_tokens.adoc | 5 ++++- .../akka-cli/akka_projects_tokens_create.adoc | 2 +- .../akka-cli/akka_projects_tokens_list.adoc | 2 +- .../akka-cli/akka_projects_tokens_revoke.adoc | 2 +- .../pages/cli/akka-cli/akka_regions.adoc | 6 +++++- .../pages/cli/akka-cli/akka_regions_list.adoc | 2 +- .../pages/cli/akka-cli/akka_roles.adoc | 2 ++ .../pages/cli/akka-cli/akka_routes.adoc | 14 +++++++++++++ .../pages/cli/akka-cli/akka_secrets.adoc | 5 ++++- .../cli/akka-cli/akka_secrets_create.adoc | 2 +- .../akka_secrets_create_asymmetric.adoc | 2 +- .../akka-cli/akka_secrets_create_generic.adoc | 2 +- .../akka_secrets_create_symmetric.adoc | 2 +- .../akka-cli/akka_secrets_create_tls-ca.adoc | 2 +- .../cli/akka-cli/akka_secrets_create_tls.adoc | 2 +- .../pages/cli/akka-cli/akka_services.adoc | 20 +++++++++---------- .../cli/akka-cli/akka_services_apply.adoc | 2 +- .../akka-cli/akka_services_components.adoc | 6 +++++- .../akka_services_components_get-state.adoc | 2 +- ...akka_services_components_get-workflow.adoc | 2 +- .../akka_services_components_list-events.adoc | 2 +- .../akka_services_components_list-ids.adoc | 2 +- .../akka_services_components_list-timers.adoc | 2 +- .../akka_services_components_list.adoc | 2 +- .../cli/akka-cli/akka_services_deploy.adoc | 6 ++++-- .../cli/akka-cli/akka_services_edit.adoc | 2 +- .../cli/akka-cli/akka_services_export.adoc | 2 +- .../cli/akka-cli/akka_services_expose.adoc | 6 ++++-- .../pages/cli/akka-cli/akka_services_get.adoc | 2 +- .../cli/akka-cli/akka_services_jwts.adoc | 2 +- .../cli/akka-cli/akka_services_jwts_add.adoc | 2 +- .../akka-cli/akka_services_jwts_generate.adoc | 2 +- .../akka_services_jwts_list-algorithms.adoc | 2 +- .../cli/akka-cli/akka_services_jwts_list.adoc | 2 +- .../akka-cli/akka_services_jwts_remove.adoc | 2 +- .../akka-cli/akka_services_jwts_update.adoc | 2 +- .../cli/akka-cli/akka_services_list.adoc | 1 + .../cli/akka-cli/akka_services_pause.adoc | 5 +++-- .../cli/akka-cli/akka_services_proxy.adoc | 1 + .../cli/akka-cli/akka_services_restart.adoc | 2 +- .../cli/akka-cli/akka_services_restore.adoc | 2 +- .../cli/akka-cli/akka_services_resume.adoc | 4 ++-- .../cli/akka-cli/akka_services_views.adoc | 4 ++++ .../pages/cli/akka-cli/akka_version.adoc | 2 +- 140 files changed, 274 insertions(+), 200 deletions(-) mode change 100644 => 100755 docs/src-static/install-cli.sh diff --git a/Makefile b/Makefile index eee00a625..b0121e16d 100644 --- a/Makefile +++ b/Makefile @@ -44,7 +44,7 @@ attributes: prepare > "${managed_partials}/attributes.adoc" docs/bin/version.sh | xargs -0 printf ":akka-javasdk-version: %s" \ > "${managed_partials}/attributes.adoc" - echo ":akka-cli-version: 3.0.5" >> "${managed_partials}/attributes.adoc" + echo ":akka-cli-version: 3.0.6" >> "${managed_partials}/attributes.adoc" echo ":akka-cli-min-version: 3.0.4" >> "${managed_partials}/attributes.adoc" # see https://adoptium.net/marketplace/ echo ":java-version: 21" \ diff --git a/docs/src-static/install-cli.sh b/docs/src-static/install-cli.sh old mode 100644 new mode 100755 diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka.adoc index e23a34062..ee20c218d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka.adoc @@ -26,21 +26,21 @@ Welcome to the Akka CLI, for more information on its usage please visit the docu * link:akka_auth.html[akka auth] - Manage Akka authentication. * link:akka_completion.html[akka completion] - Generate shell completion scripts -* link:akka_config.html[akka config] - Manage the local Akka configuration. -* link:akka_container-registry.html[akka container-registry] - Manage the Akka Container Registry. -* link:akka_docker.html[akka docker] - Manage Docker credentials for Akka projects. -* link:akka_docs.html[akka docs] - Opens the Akka documentation page -* link:akka_local.html[akka local] - Helps with local development. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. +* link:akka_container-registry.html[akka container-registry] - Manage and push service images to the Akka Container Registry. +* link:akka_docker.html[akka docker] - Manage credentials for projects using private Docker registries. +* link:akka_docs.html[akka docs] - Open the Akka documentation page +* link:akka_local.html[akka local] - Interact with and manage Akka services running locally. * link:akka_logs.html[akka logs] - Display the last few lines of logs for a specific service. * link:akka_organizations.html[akka organizations] - Manage your organizations on Akka * link:akka_projects.html[akka projects] - Manage your Akka projects. * link:akka_quickstart.html[akka quickstart] - Akka quickstart project samples. -* link:akka_regions.html[akka regions] - Manage regions on Akka +* link:akka_regions.html[akka regions] - Manage available regions. * link:akka_roles.html[akka roles] - Manage the user roles for an Akka project. * link:akka_routes.html[akka routes] - Manage routes for your Akka project. * link:akka_secrets.html[akka secrets] - Manage secrets for an Akka project. * link:akka_services.html[akka services] - Manage and deploy services on Akka. -* link:akka_version.html[akka version] - Prints the akka version +* link:akka_version.html[akka version] - Print the akka CLI version [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth.adoc index 788d6880a..6726a6cbf 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth.adoc @@ -31,12 +31,12 @@ When authorized, you can use the CLI to perform the same operations available in == SEE ALSO * link:akka.html[akka] - Akka control -* link:akka_auth_container-registry.html[akka auth container-registry] - Manage the Akka Container Registry configuration. +* link:akka_auth_container-registry.html[akka auth container-registry] - Manage configuration for Akka Container Registry. * link:akka_auth_current-login.html[akka auth current-login] - Get details for the current logged in user. * link:akka_auth_login.html[akka auth login] - Log in to Akka. * link:akka_auth_logout.html[akka auth logout] - Log out the current user. -* link:akka_auth_signup.html[akka auth signup] - Opens the registration page. -* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens. +* link:akka_auth_signup.html[akka auth signup] - Open the registration page. +* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens for your user. * link:akka_auth_use-token.html[akka auth use-token] - Login using a token. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry.adoc index 8378066bb..e159d4c65 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry.adoc @@ -1,10 +1,14 @@ = akka auth container-registry -Manage the Akka Container Registry configuration. +Manage configuration for Akka Container Registry. == Synopsis -The Akka Container Registry (ACR) can be used by all Akka users to deploy services and is available in all Akka regions. +The Akka Container Registry (ACR) can be used by all users to deploy their services. +ACR uses an access token generated via Akka for authentication. +This command allows you to configure the Docker credential helper for ACR. + +NOTE: to use this command, the current user must be logged into Akka and Docker must be installed and accessible for the current user. == Options @@ -32,8 +36,8 @@ The Akka Container Registry (ACR) can be used by all Akka users to deploy servic * link:akka_auth.html[akka auth] - Manage Akka authentication. * link:akka_auth_container-registry_clear-cached-token.html[akka auth container-registry clear-cached-token] - Clear the cached Akka Container Registry access token. * link:akka_auth_container-registry_configure.html[akka auth container-registry configure] - Configure the Akka Container Registry docker credential helper. -* link:akka_auth_container-registry_credentials.html[akka auth container-registry credentials] - Retrieves an Akka Container Registry access token for the current user. -* link:akka_auth_container-registry_install-helper.html[akka auth container-registry install-helper] - Installs the Akka Docker credential helper in the selected directory. +* link:akka_auth_container-registry_credentials.html[akka auth container-registry credentials] - Retrieve an Akka Container Registry access token for the current user. +* link:akka_auth_container-registry_install-helper.html[akka auth container-registry install-helper] - Install the Akka Docker credential helper in the selected directory. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_clear-cached-token.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_clear-cached-token.adoc index c9f75388e..61f04c1df 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_clear-cached-token.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_clear-cached-token.adoc @@ -31,7 +31,7 @@ akka auth container-registry clear-cached-token [flags] == SEE ALSO -* link:akka_auth_container-registry.html[akka auth container-registry] - Manage the Akka Container Registry configuration. +* link:akka_auth_container-registry.html[akka auth container-registry] - Manage configuration for Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_configure.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_configure.adoc index ee0e62dca..77c89823f 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_configure.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_configure.adoc @@ -33,7 +33,7 @@ akka auth container-registry configure [flags] == SEE ALSO -* link:akka_auth_container-registry.html[akka auth container-registry] - Manage the Akka Container Registry configuration. +* link:akka_auth_container-registry.html[akka auth container-registry] - Manage configuration for Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_credentials.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_credentials.adoc index 8b3e90c1a..87bf5e850 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_credentials.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_credentials.adoc @@ -1,6 +1,6 @@ = akka auth container-registry credentials -Retrieves an Akka Container Registry access token for the current user. +Retrieve an Akka Container Registry access token for the current user. ---- akka auth container-registry credentials [flags] @@ -32,7 +32,7 @@ akka auth container-registry credentials [flags] == SEE ALSO -* link:akka_auth_container-registry.html[akka auth container-registry] - Manage the Akka Container Registry configuration. +* link:akka_auth_container-registry.html[akka auth container-registry] - Manage configuration for Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_install-helper.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_install-helper.adoc index 90e11728e..5fb899be1 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_install-helper.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_container-registry_install-helper.adoc @@ -1,6 +1,6 @@ = akka auth container-registry install-helper -Installs the Akka Docker credential helper in the selected directory. +Install the Akka Docker credential helper in the selected directory. == Synopsis @@ -33,7 +33,7 @@ akka auth container-registry install-helper [flags] == SEE ALSO -* link:akka_auth_container-registry.html[akka auth container-registry] - Manage the Akka Container Registry configuration. +* link:akka_auth_container-registry.html[akka auth container-registry] - Manage configuration for Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_signup.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_signup.adoc index 78f2aab0c..98f4d971c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_signup.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_signup.adoc @@ -1,6 +1,6 @@ = akka auth signup -Opens the registration page. +Open the registration page. ---- akka auth signup [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens.adoc index f9015a1c9..f2aff97f9 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens.adoc @@ -1,6 +1,10 @@ = akka auth tokens -Manage Akka authentication tokens. +Manage Akka authentication tokens for your user. + +== Synopsis + +The command `akka auth tokens` manage the authentication tokens for your user allowing you to revoke any token at any time, but also to create new tokens for use in CI/CD pipelines for machine-user accounts. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_create.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_create.adoc index fda93603f..d85ff5870 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_create.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_create.adoc @@ -43,7 +43,7 @@ Token created: 0123456789abcdef0123456789abcdef0123456789abcdef == SEE ALSO -* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens. +* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens for your user. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_list.adoc index 50c6acd36..bec1126ae 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_list.adoc @@ -35,7 +35,7 @@ akka auth tokens list [flags] == SEE ALSO -* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens. +* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens for your user. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_revoke.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_revoke.adoc index 14430ed80..a3ea54703 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_revoke.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_auth_tokens_revoke.adoc @@ -37,7 +37,7 @@ akka auth tokens revoke ID [flags] == SEE ALSO -* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens. +* link:akka_auth_tokens.html[akka auth tokens] - Manage Akka authentication tokens for your user. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config.adoc index f346a4f0e..4a6490161 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config.adoc @@ -1,10 +1,13 @@ = akka config -Manage the local Akka configuration. +Manage configuration and context for the Akka CLI. == Synopsis The `akka config` commands display and set configuration contexts and values that apply to subsequent commands. +These are often useful to make your CLI experience more fluid. +For example, by having set a default _project_, you can avoid specifying the project id or name in every command. + Configuration settings are stored in a file on your local system, by default at `.akka/config.yaml` in your home directory. This location can be adjusted with the `--config` flag. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear-cache.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear-cache.adoc index 4f4315885..056d5e5fe 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear-cache.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear-cache.adoc @@ -33,7 +33,7 @@ akka config clear-cache [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear.adoc index 006369fe7..29871879d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_clear.adoc @@ -33,7 +33,7 @@ akka config clear KEY [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_current-context.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_current-context.adoc index 7b79505a3..10b2089ef 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_current-context.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_current-context.adoc @@ -34,7 +34,7 @@ akka config current-context [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_delete-context.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_delete-context.adoc index 00c893486..77869f69d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_delete-context.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_delete-context.adoc @@ -33,7 +33,7 @@ akka config delete-context CONTEXT [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-organization.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-organization.adoc index e5310b1b2..cb6340968 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-organization.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-organization.adoc @@ -29,7 +29,7 @@ akka config get-organization [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-project.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-project.adoc index 5cba549d2..f6b64f0e0 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-project.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get-project.adoc @@ -29,7 +29,7 @@ akka config get-project [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get.adoc index 34eb39b0b..b642bc642 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_get.adoc @@ -33,7 +33,7 @@ akka config get KEY [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list-contexts.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list-contexts.adoc index 2381426e7..1282b354d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list-contexts.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list-contexts.adoc @@ -33,7 +33,7 @@ akka config list-contexts [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list.adoc index 7ffd9c805..a31c4a871 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_list.adoc @@ -33,7 +33,7 @@ akka config list [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_rename-context.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_rename-context.adoc index c29f1bbe7..2f0a70124 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_rename-context.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_rename-context.adoc @@ -33,7 +33,7 @@ akka config rename-context CONTEXT [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_set.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_set.adoc index 489d4e2a6..a218af9bc 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_set.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_set.adoc @@ -37,7 +37,7 @@ akka config set KEY VALUE [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_use-context.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_use-context.adoc index 38200bb43..f597a1ef4 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_config_use-context.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_config_use-context.adoc @@ -37,7 +37,7 @@ akka config use-context CONTEXT [flags] == SEE ALSO -* link:akka_config.html[akka config] - Manage the local Akka configuration. +* link:akka_config.html[akka config] - Manage configuration and context for the Akka CLI. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry.adoc index 6077a67d1..cc7137a2d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry.adoc @@ -1,10 +1,13 @@ = akka container-registry -Manage the Akka Container Registry. +Manage and push service images to the Akka Container Registry. == Synopsis -The Akka Container Registry (ACR) can be used by all Akka users to deploy services and is available in all Akka regions. +The Akka Container Registry (ACR) can be used by all users to deploy their services. +ACR makes service container images available to Akka in all regions automatically. + +NOTE: to use an external Docker registry instead, refer to the documentation https://doc.akka.io/operations/projects/external-container-registries.html . == Options @@ -30,11 +33,11 @@ The Akka Container Registry (ACR) can be used by all Akka users to deploy servic == SEE ALSO * link:akka.html[akka] - Akka control -* link:akka_container-registry_delete-image.html[akka container-registry delete-image] - delete image from the Akka Container Registry. -If no tag is provided, it deletes all tags +* link:akka_container-registry_delete-image.html[akka container-registry delete-image] - Delete image from the Akka Container Registry. +If no tag is provided, it deletes all tags. * link:akka_container-registry_list.html[akka container-registry list] - List the Akka Container Registry and region. * link:akka_container-registry_list-images.html[akka container-registry list-images] - list images from the Akka Container Registry. -* link:akka_container-registry_list-tags.html[akka container-registry list-tags] - list all images tags. +* link:akka_container-registry_list-tags.html[akka container-registry list-tags] - List all images tags. * link:akka_container-registry_print.html[akka container-registry print] - Print the path of the Akka Container Registry. * link:akka_container-registry_push.html[akka container-registry push] - Push an Akka service image for a particular Akka project. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_delete-image.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_delete-image.adoc index e913bf793..ec17fd203 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_delete-image.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_delete-image.adoc @@ -1,10 +1,10 @@ = akka container-registry delete-image -delete image from the Akka Container Registry. -If no tag is provided, it deletes all tags +Delete image from the Akka Container Registry. +If no tag is provided, it deletes all tags. ---- -akka container-registry delete-image [:] [flags] +akka container-registry delete-image _image_[:] [flags] ---- == Options @@ -30,7 +30,7 @@ akka container-registry delete-image [:] [flags] == SEE ALSO -* link:akka_container-registry.html[akka container-registry] - Manage the Akka Container Registry. +* link:akka_container-registry.html[akka container-registry] - Manage and push service images to the Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-images.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-images.adoc index e2aa6af21..626cdfedc 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-images.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-images.adoc @@ -31,7 +31,7 @@ akka container-registry list-images [flags] == SEE ALSO -* link:akka_container-registry.html[akka container-registry] - Manage the Akka Container Registry. +* link:akka_container-registry.html[akka container-registry] - Manage and push service images to the Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-tags.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-tags.adoc index 868f14643..2ea416e30 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-tags.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list-tags.adoc @@ -1,6 +1,6 @@ = akka container-registry list-tags -list all images tags. +List all images tags. == Synopsis @@ -35,7 +35,7 @@ akka container-registry list-tags IMAGE [flags] == SEE ALSO -* link:akka_container-registry.html[akka container-registry] - Manage the Akka Container Registry. +* link:akka_container-registry.html[akka container-registry] - Manage and push service images to the Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list.adoc index 45fbcc1d9..82de78658 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_list.adoc @@ -29,7 +29,7 @@ akka container-registry list [flags] == SEE ALSO -* link:akka_container-registry.html[akka container-registry] - Manage the Akka Container Registry. +* link:akka_container-registry.html[akka container-registry] - Manage and push service images to the Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_print.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_print.adoc index e01619bb7..cb176eeec 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_print.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_print.adoc @@ -29,7 +29,7 @@ akka container-registry print [flags] == SEE ALSO -* link:akka_container-registry.html[akka container-registry] - Manage the Akka Container Registry. +* link:akka_container-registry.html[akka container-registry] - Manage and push service images to the Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_push.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_push.adoc index 519900b1f..22118e27a 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_push.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_container-registry_push.adoc @@ -4,15 +4,15 @@ Push an Akka service image for a particular Akka project. == Synopsis -The `akka container-registry push ` command will push the given container image to the Akka container registry. +The `akka container-registry push _image_` command will push the given container image to the Akka container registry. The provided image name must be a valid Docker image tag and not an image hash/SHA-256. -This command will replace the `HOST[:PORT_NUMBER]` portion of the specified ++++++with the appropriate Akka container registry hostname if it does not match the expected hostname. +This command will replace the `HOST[:PORT_NUMBER]` portion of the specified _image_ with the appropriate Akka container registry hostname if it does not match the expected hostname. This command is also multi-region aware. -If the current (or specified) Akka project is a multi-region project, the provided ++++++will be tagged with a new tag for each Akka region where the project resides and this command will push the image to each of those regions for you.++++++++++++ +If the current (or specified) Akka project is a multi-region project, the provided _image_ will be tagged with a new tag for each Akka region where the project resides and this command will push the image to each of those regions for you. -NOTE: You must have the source ++++++in your local Docker service image catalog for this command to function. -If the image is not locally stored, you can pull it (via `docker pull ++++++` first before running this command.++++++++++++ +NOTE: You must have the source _image_ in your local Docker service image catalog for this command to function. +If the image is not locally stored, you can pull it (via `docker pull _image_` first before running this command. ---- akka container-registry push IMAGE [flags] @@ -43,7 +43,7 @@ akka container-registry push IMAGE [flags] == SEE ALSO -* link:akka_container-registry.html[akka container-registry] - Manage the Akka Container Registry. +* link:akka_container-registry.html[akka container-registry] - Manage and push service images to the Akka Container Registry. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker.adoc index 1cf4193ef..fee0d4a1e 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker.adoc @@ -1,6 +1,6 @@ = akka docker -Manage Docker credentials for Akka projects. +Manage credentials for projects using private Docker registries. == Synopsis diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_add-credentials.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_add-credentials.adoc index 3c8a8be94..2f8c0a9d9 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_add-credentials.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_add-credentials.adoc @@ -5,6 +5,7 @@ Add Docker credentials to an Akka project. == Synopsis Use the `akka docker add-credentials [flags]` command to add a set of Docker credentials to the project. +With this, any service in the project can be deployed based on images from the private Docker registry. ---- akka docker add-credentials [flags] @@ -45,7 +46,7 @@ akka docker add-credentials [flags] == SEE ALSO -* link:akka_docker.html[akka docker] - Manage Docker credentials for Akka projects. +* link:akka_docker.html[akka docker] - Manage credentials for projects using private Docker registries. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_list-credentials.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_list-credentials.adoc index 266d3b951..9a1a3bcea 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_list-credentials.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_list-credentials.adoc @@ -38,7 +38,7 @@ akka docker list-credentials [flags] == SEE ALSO -* link:akka_docker.html[akka docker] - Manage Docker credentials for Akka projects. +* link:akka_docker.html[akka docker] - Manage credentials for projects using private Docker registries. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_remove-credentials.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_remove-credentials.adoc index ee63bf95e..8ff52509c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_remove-credentials.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_docker_remove-credentials.adoc @@ -38,7 +38,7 @@ akka docker remove-credentials SECRET [flags] == SEE ALSO -* link:akka_docker.html[akka docker] - Manage Docker credentials for Akka projects. +* link:akka_docker.html[akka docker] - Manage credentials for projects using private Docker registries. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_docs.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_docs.adoc index d7789f933..bbc3b75dc 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_docs.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_docs.adoc @@ -1,6 +1,6 @@ = akka docs -Opens the Akka documentation page +Open the Akka documentation page ---- akka docs [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local.adoc index 63e65bc80..a6822f6e3 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local.adoc @@ -1,10 +1,10 @@ = akka local -Helps with local development. +Interact with and manage Akka services running locally. == Synopsis -The `akka local` commands help with local development. +The `akka local` commands help with local development by providing ways to interact with, discover and explore Akka services and its data when running them locally. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_console.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_console.adoc index 4912d2220..6a4087f5d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_console.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_console.adoc @@ -34,7 +34,7 @@ akka local console [flags] == SEE ALSO -* link:akka_local.html[akka local] - Helps with local development. +* link:akka_local.html[akka local] - Interact with and manage Akka services running locally. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services.adoc index 1e85ed8d9..3ccffe7f9 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services.adoc @@ -4,7 +4,7 @@ Manage Akka services locally. == Synopsis -The `akka local services` commands are used to manage and modify the services in your Akka project. +The `akka local services` commands are used for development purposes to interact with Akka services running locally. == Options @@ -29,8 +29,8 @@ The `akka local services` commands are used to manage and modify the services in == SEE ALSO -* link:akka_local.html[akka local] - Helps with local development. -* link:akka_local_services_components.html[akka local services components] - Manage the components of a service. +* link:akka_local.html[akka local] - Interact with and manage Akka services running locally. +* link:akka_local_services_components.html[akka local services components] - Inspect components of a service. * link:akka_local_services_connectivity.html[akka local services connectivity] - Summarize all services connectivity and status. * link:akka_local_services_list.html[akka local services list] - List all services. * link:akka_local_services_views.html[akka local services views] - Manage views. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components.adoc index a26ec98ff..9e7803072 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components.adoc @@ -1,6 +1,10 @@ = akka local services components -Manage the components of a service. +Inspect components of a service. + +== Synopsis + +The `akka service components` commands provides a way to inspect the components of a service but also to peek at the data stored in the different entities. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-state.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-state.adoc index 02d9c5a1b..3963948ba 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-state.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-state.adoc @@ -37,7 +37,7 @@ akka local services components get-state SERVICE_NAME COMPONENT_NAME ID [flags] == SEE ALSO -* link:akka_local_services_components.html[akka local services components] - Manage the components of a service. +* link:akka_local_services_components.html[akka local services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-workflow.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-workflow.adoc index 71c31dd9a..2424670e4 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-workflow.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_get-workflow.adoc @@ -37,7 +37,7 @@ akka local services components get-workflow SERVICE_NAME COMPONENT_NAME WORKFLOW == SEE ALSO -* link:akka_local_services_components.html[akka local services components] - Manage the components of a service. +* link:akka_local_services_components.html[akka local services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-events.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-events.adoc index ff28dc70d..83b15e1ab 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-events.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-events.adoc @@ -41,7 +41,7 @@ akka local services components list-events SERVICE_NAME COMPONENT_NAME ENTITY_ID == SEE ALSO -* link:akka_local_services_components.html[akka local services components] - Manage the components of a service. +* link:akka_local_services_components.html[akka local services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-ids.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-ids.adoc index 46b1131aa..16f2c92bc 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-ids.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-ids.adoc @@ -39,7 +39,7 @@ akka local services components list-ids SERVICE_NAME COMPONENT_NAME [flags] == SEE ALSO -* link:akka_local_services_components.html[akka local services components] - Manage the components of a service. +* link:akka_local_services_components.html[akka local services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-timers.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-timers.adoc index d12027bc8..5bfae8019 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-timers.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list-timers.adoc @@ -41,7 +41,7 @@ akka local services components list-timers SERVICE_NAME [flags] == SEE ALSO -* link:akka_local_services_components.html[akka local services components] - Manage the components of a service. +* link:akka_local_services_components.html[akka local services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list.adoc index 4e31b41c7..51abfc410 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_components_list.adoc @@ -36,7 +36,7 @@ akka local services components list SERVICE [flags] == SEE ALSO -* link:akka_local_services_components.html[akka local services components] - Manage the components of a service. +* link:akka_local_services_components.html[akka local services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_list.adoc index 659ed583a..6b4c3303e 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_list.adoc @@ -5,6 +5,7 @@ List all services. == Synopsis The `akka local services list` command lists a one-line summary of all services under your current project. +By default, it shows information for the primary region of the configured project only. ---- akka local services list [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_views.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_views.adoc index 388916586..26701f763 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_views.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_local_services_views.adoc @@ -2,6 +2,10 @@ Manage views. +== Synopsis + +The `akka local service views` commands manage the views for an Akka project, including listing of existing views and deleting views and their data when a view is no longer used. + == Options ---- diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations.adoc index 3ca09cb98..1ad19cb8c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations.adoc @@ -5,6 +5,8 @@ Manage your organizations on Akka == Synopsis The `akka organizations` commands manage the organizations in your Akka account. +Organizations are the root of the management hierarchy and serve as a container for all Projects where Services are deployed. +For more details on organizations, see https://doc.akka.io/operations/organizations/index.html . == Options @@ -32,8 +34,8 @@ The `akka organizations` commands manage the organizations in your Akka account. * link:akka.html[akka] - Akka control * link:akka_organizations_auth.html[akka organizations auth] - Manage authentication for your organization on Akka * link:akka_organizations_get.html[akka organizations get] - Get organization information. -* link:akka_organizations_invitations.html[akka organizations invitations] - invitations -* link:akka_organizations_list.html[akka organizations list] - List all organizations of which the user is a member. +* link:akka_organizations_invitations.html[akka organizations invitations] - Invite new users to the organization with a specific role. +* link:akka_organizations_list.html[akka organizations list] - List all organizations of which the user is a member of. * link:akka_organizations_users.html[akka organizations users] - Manage organization users. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_auth.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_auth.adoc index 0e16cb04a..fec238992 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_auth.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_auth.adoc @@ -5,6 +5,7 @@ Manage authentication for your organization on Akka == Synopsis The `akka organizations auth` commands manage the authentication for organizations in Akka. +For example, you can configure your organization to use OpenID Connect (OIDC) for authentication. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations.adoc index 6522ae69a..c30cf7b8c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations.adoc @@ -1,6 +1,6 @@ = akka organizations invitations -invitations +Invite new users to the organization with a specific role. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_cancel.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_cancel.adoc index d0bcb3ae7..0903706ce 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_cancel.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_cancel.adoc @@ -31,7 +31,7 @@ akka organizations invitations cancel --email INVITEE'S_EMAIL [flags] == SEE ALSO -* link:akka_organizations_invitations.html[akka organizations invitations] - invitations +* link:akka_organizations_invitations.html[akka organizations invitations] - Invite new users to the organization with a specific role. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_create.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_create.adoc index 4432590df..c7f91e489 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_create.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_create.adoc @@ -32,7 +32,7 @@ akka organizations invitations create --email EMAIL --role ROLE [flags] == SEE ALSO -* link:akka_organizations_invitations.html[akka organizations invitations] - invitations +* link:akka_organizations_invitations.html[akka organizations invitations] - Invite new users to the organization with a specific role. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_list.adoc index 29766e9c1..89cef930a 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_invitations_list.adoc @@ -30,7 +30,7 @@ akka organizations invitations list [flags] == SEE ALSO -* link:akka_organizations_invitations.html[akka organizations invitations] - invitations +* link:akka_organizations_invitations.html[akka organizations invitations] - Invite new users to the organization with a specific role. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_list.adoc index 467037089..586fb8561 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_organizations_list.adoc @@ -1,6 +1,6 @@ = akka organizations list -List all organizations of which the user is a member. +List all organizations of which the user is a member of. ---- akka organizations list [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects.adoc index 272985da9..97b2fbea1 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects.adoc @@ -5,6 +5,8 @@ Manage your Akka projects. == Synopsis The `akka projects` commands manipulate the projects in your Akka account, where a project is a collection of services. +A project can be deployed to one or more regions. +For more details on projects, see https://doc.akka.io/operations/projects/index.html == Options @@ -36,10 +38,10 @@ The `akka projects` commands manipulate the projects in your Akka account, where * link:akka_projects_hostnames.html[akka projects hostnames] - Manage hostnames for your Akka project. * link:akka_projects_list.html[akka projects list] - List all projects. * link:akka_projects_new.html[akka projects new] - Create a new Akka project. -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project -* link:akka_projects_open.html[akka projects open] - Opens the current project in the console. -* link:akka_projects_regions.html[akka projects regions] - Manage the regions for your Akka project -* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. +* link:akka_projects_open.html[akka projects open] - Open the current project in the console. +* link:akka_projects_regions.html[akka projects regions] - Manage the regions assigned to your Akka project. +* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens. * link:akka_projects_update.html[akka projects update] - Update project attributes such as name and description. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_delete.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_delete.adoc index 6c881a12a..48213b9d5 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_delete.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_delete.adoc @@ -4,7 +4,8 @@ Delete a project. == Synopsis -The `akka projects delete PROJECT` command will delete the project. +The `akka projects delete _project-name_` command will delete the project. +If the project still has running services, you will need to delete them first. TIP: Use `akka projects list` to identify a project. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_get.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_get.adoc index effcbb732..48492535f 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_get.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_get.adoc @@ -4,9 +4,10 @@ Get project information. == Synopsis -The `akka projects get _id_` command will display information about the project with the id _id_, if it exists. +The `akka projects get _name_` command will display information about the project with name _name_, if it exists. +Using the _id_ of the project is also supported. -TIP: Use `akka projects list` to identify a project's _id_. +TIP: Use `akka projects list` to confirm the project's _name_ or _id_. ---- akka projects get PROJECT [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability.adoc index 3be556471..923607213 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability.adoc @@ -1,10 +1,11 @@ = akka projects observability -Manage the observability settings for your Akka project +Manage the observability settings for your Akka project. == Synopsis -The `akka project observability` command manages the observability settings for your Akka project. +The `akka project observability` command manages the observability settings for your Akka project, allowing you to configure exporters for metrics, logs, and traces so you can ship those to your observability platform of choice. +These observability settings are applied to all services in your project. == Options @@ -30,13 +31,13 @@ The `akka project observability` command manages the observability settings for == SEE ALSO * link:akka_projects.html[akka projects] - Manage your Akka projects. -* link:akka_projects_observability_apply.html[akka projects observability apply] - Applies an observability descriptor to the currently configured project. -* link:akka_projects_observability_config.html[akka projects observability config] - Manage the observability configuration for your Akka project +* link:akka_projects_observability_apply.html[akka projects observability apply] - Apply an observability descriptor to the currently configured project. +* link:akka_projects_observability_config.html[akka projects observability config] - Manage the observability configuration for your Akka project. * link:akka_projects_observability_edit.html[akka projects observability edit] - Edit observability configuration for your Akka project. -* link:akka_projects_observability_export.html[akka projects observability export] - Exports an observability descriptor from the currently configured project. +* link:akka_projects_observability_export.html[akka projects observability export] - Export an observability descriptor from the currently configured project. * link:akka_projects_observability_get.html[akka projects observability get] - Get observability configuration for your Akka project. -* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project -* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project +* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project. +* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_apply.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_apply.adoc index 9accc1577..3c2c227b1 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_apply.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_apply.adoc @@ -1,6 +1,6 @@ = akka projects observability apply -Applies an observability descriptor to the currently configured project. +Apply an observability descriptor to the currently configured project. == Synopsis @@ -45,7 +45,7 @@ akka project observability apply -f _file-name_ == SEE ALSO -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config.adoc index f3f389860..5549351f0 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config.adoc @@ -1,6 +1,6 @@ = akka projects observability config -Manage the observability configuration for your Akka project +Manage the observability configuration for your Akka project. == Synopsis @@ -29,8 +29,8 @@ The `akka project observability config` command manages the observability config == SEE ALSO -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project -* link:akka_projects_observability_config_traces.html[akka projects observability config traces] - Configure traces sampling for your Akka project +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. +* link:akka_projects_observability_config_traces.html[akka projects observability config traces] - Configure traces sampling for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config_traces.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config_traces.adoc index de583a9c0..3624fa67c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config_traces.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_config_traces.adoc @@ -1,6 +1,6 @@ = akka projects observability config traces -Configure traces sampling for your Akka project +Configure traces sampling for your Akka project. == Synopsis @@ -39,7 +39,7 @@ akka projects observability config traces [flags] == SEE ALSO -* link:akka_projects_observability_config.html[akka projects observability config] - Manage the observability configuration for your Akka project +* link:akka_projects_observability_config.html[akka projects observability config] - Manage the observability configuration for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_edit.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_edit.adoc index c330764c7..f323644dc 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_edit.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_edit.adoc @@ -38,7 +38,7 @@ akka projects observability edit [flags] == SEE ALSO -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_export.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_export.adoc index 0799895dc..0ae4d2c9b 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_export.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_export.adoc @@ -1,6 +1,6 @@ = akka projects observability export -Exports an observability descriptor from the currently configured project. +Export an observability descriptor from the currently configured project. == Synopsis @@ -45,7 +45,7 @@ akka project observability export -f _file-name_ == SEE ALSO -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_get.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_get.adoc index 84e0a716a..9453514af 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_get.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_get.adoc @@ -37,7 +37,7 @@ akka projects observability get [flags] == SEE ALSO -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set.adoc index abad55d37..98d5cb42c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set.adoc @@ -1,6 +1,6 @@ = akka projects observability set -Set the observability settings for your Akka project +Set the observability settings for your Akka project. == Synopsis @@ -29,11 +29,11 @@ The `akka project observability set` command sets the observability settings for == SEE ALSO -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project -* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project -* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project -* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project -* link:akka_projects_observability_set_traces.html[akka projects observability set traces] - Set the traces exporter for your Akka project +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. +* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project. +* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project. +* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project. +* link:akka_projects_observability_set_traces.html[akka projects observability set traces] - Set the traces exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default.adoc index dafda39ab..b56d03f03 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default.adoc @@ -1,10 +1,10 @@ = akka projects observability set default -Set the default exporter for your Akka project +Set the default exporter for your Akka project. == Synopsis -The `akka project observability set default` command sets the default exporter for your Kalix project. +The `akka project observability set default` command sets the default exporter for your Akka project. Setting a default exporter will unset all other exporters configured for your project. @@ -31,7 +31,7 @@ Setting a default exporter will unset all other exporters configured for your pr == SEE ALSO -* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project +* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project. * link:akka_projects_observability_set_default_akka-console.html[akka projects observability set default akka-console] - Set your project to export metrics to the Akka console. This will unset all other exporter configuration. * link:akka_projects_observability_set_default_google-cloud.html[akka projects observability set default google-cloud] - Set your project to export default to Google Cloud. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_akka-console.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_akka-console.adoc index 7087f002e..3132df575 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_akka-console.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_akka-console.adoc @@ -35,7 +35,7 @@ akka projects observability set default akka-console [flags] == SEE ALSO -* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project +* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_google-cloud.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_google-cloud.adoc index 0a9e1fd14..745f02c42 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_google-cloud.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_google-cloud.adoc @@ -35,7 +35,7 @@ akka projects observability set default google-cloud [flags] == SEE ALSO -* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project +* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_otlp.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_otlp.adoc index 4078accec..af6d29f9d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_otlp.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_otlp.adoc @@ -41,7 +41,7 @@ akka projects observability set default otlp [flags] == SEE ALSO -* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project +* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_splunk-hec.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_splunk-hec.adoc index 7acf29b61..00d1a1ea0 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_splunk-hec.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_default_splunk-hec.adoc @@ -44,7 +44,7 @@ akka projects observability set default splunk-hec [flags] == SEE ALSO -* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project +* link:akka_projects_observability_set_default.html[akka projects observability set default] - Set the default exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs.adoc index e546de491..86ba89bfd 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs.adoc @@ -1,6 +1,6 @@ = akka projects observability set logs -Set the logs exporter for your Akka project +Set the logs exporter for your Akka project. == Synopsis @@ -29,7 +29,7 @@ The `akka project observability set logs` command sets the logs exporter for you == SEE ALSO -* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project +* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project. * link:akka_projects_observability_set_logs_google-cloud.html[akka projects observability set logs google-cloud] - Set your project to export logs to Google Cloud. * link:akka_projects_observability_set_logs_otlp.html[akka projects observability set logs otlp] - Set your project to export logs to an OTLP collector. * link:akka_projects_observability_set_logs_splunk-hec.html[akka projects observability set logs splunk-hec] - Set your project to export logs to a Splunk HEC endpoint. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_google-cloud.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_google-cloud.adoc index 15884835c..e5005dee2 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_google-cloud.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_google-cloud.adoc @@ -35,7 +35,7 @@ akka projects observability set logs google-cloud [flags] == SEE ALSO -* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project +* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_otlp.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_otlp.adoc index 87c848a6f..68823155a 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_otlp.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_otlp.adoc @@ -41,7 +41,7 @@ akka projects observability set logs otlp [flags] == SEE ALSO -* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project +* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_splunk-hec.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_splunk-hec.adoc index d3eadcec0..654e215fc 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_splunk-hec.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_logs_splunk-hec.adoc @@ -44,7 +44,7 @@ akka projects observability set logs splunk-hec [flags] == SEE ALSO -* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project +* link:akka_projects_observability_set_logs.html[akka projects observability set logs] - Set the logs exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics.adoc index 34329c1a9..92ad8d60b 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics.adoc @@ -1,6 +1,6 @@ = akka projects observability set metrics -Set the metrics exporter for your Akka project +Set the metrics exporter for your Akka project. == Synopsis @@ -29,7 +29,7 @@ The `akka project observability set metrics` command sets the metrics exporter f == SEE ALSO -* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project +* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project. * link:akka_projects_observability_set_metrics_google-cloud.html[akka projects observability set metrics google-cloud] - Set your project to export metrics to Google Cloud. * link:akka_projects_observability_set_metrics_otlp.html[akka projects observability set metrics otlp] - Set your project to export metrics to an OTLP collector. * link:akka_projects_observability_set_metrics_prometheus.html[akka projects observability set metrics prometheus] - Set your project to export metrics to a Prometheus instance via the Prometheus remote write protocol. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_google-cloud.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_google-cloud.adoc index 5f19af4e4..d553ade37 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_google-cloud.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_google-cloud.adoc @@ -35,7 +35,7 @@ akka projects observability set metrics google-cloud [flags] == SEE ALSO -* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project +* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_otlp.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_otlp.adoc index 6bc67d0ad..bfcddacd3 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_otlp.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_otlp.adoc @@ -41,7 +41,7 @@ akka projects observability set metrics otlp [flags] == SEE ALSO -* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project +* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_prometheus.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_prometheus.adoc index 98125fcb8..6b96a0a16 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_prometheus.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_prometheus.adoc @@ -41,7 +41,7 @@ akka projects observability set metrics prometheus [flags] == SEE ALSO -* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project +* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_splunk-hec.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_splunk-hec.adoc index 57e79896b..3896d1de8 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_splunk-hec.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_metrics_splunk-hec.adoc @@ -44,7 +44,7 @@ akka projects observability set metrics splunk-hec [flags] == SEE ALSO -* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project +* link:akka_projects_observability_set_metrics.html[akka projects observability set metrics] - Set the metrics exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces.adoc index 664194886..ff208ae4b 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces.adoc @@ -1,6 +1,6 @@ = akka projects observability set traces -Set the traces exporter for your Akka project +Set the traces exporter for your Akka project. == Synopsis @@ -29,7 +29,7 @@ The `akka project observability set traces` command sets the traces exporter for == SEE ALSO -* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project +* link:akka_projects_observability_set.html[akka projects observability set] - Set the observability settings for your Akka project. * link:akka_projects_observability_set_traces_google-cloud.html[akka projects observability set traces google-cloud] - Set your project to export traces to Google Cloud. * link:akka_projects_observability_set_traces_otlp.html[akka projects observability set traces otlp] - Set your project to export traces to an OTLP collector. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_google-cloud.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_google-cloud.adoc index b2abd3517..c4e854d7b 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_google-cloud.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_google-cloud.adoc @@ -35,7 +35,7 @@ akka projects observability set traces google-cloud [flags] == SEE ALSO -* link:akka_projects_observability_set_traces.html[akka projects observability set traces] - Set the traces exporter for your Akka project +* link:akka_projects_observability_set_traces.html[akka projects observability set traces] - Set the traces exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_otlp.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_otlp.adoc index 1461bf75b..328bd6d06 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_otlp.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_set_traces_otlp.adoc @@ -41,7 +41,7 @@ akka projects observability set traces otlp [flags] == SEE ALSO -* link:akka_projects_observability_set_traces.html[akka projects observability set traces] - Set the traces exporter for your Akka project +* link:akka_projects_observability_set_traces.html[akka projects observability set traces] - Set the traces exporter for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset.adoc index b70c07a5f..01e654815 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset.adoc @@ -1,6 +1,6 @@ = akka projects observability unset -Unset the observability settings for your Akka project +Unset the observability settings for your Akka project. == Synopsis @@ -29,7 +29,7 @@ The `akka project observability unset` command unsets the observability settings == SEE ALSO -* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project +* link:akka_projects_observability.html[akka projects observability] - Manage the observability settings for your Akka project. * link:akka_projects_observability_unset_default.html[akka projects observability unset default] - Unset the observability configuration at the default scope of your project. * link:akka_projects_observability_unset_logs.html[akka projects observability unset logs] - Unset the observability configuration at the logs scope of your project. * link:akka_projects_observability_unset_metrics.html[akka projects observability unset metrics] - Unset the observability configuration at the metrics scope of your project. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_default.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_default.adoc index 111b3ca58..b0fe55b38 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_default.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_default.adoc @@ -34,7 +34,7 @@ akka projects observability unset default [flags] == SEE ALSO -* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project +* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_logs.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_logs.adoc index 181d116ac..30aaab55a 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_logs.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_logs.adoc @@ -34,7 +34,7 @@ akka projects observability unset logs [flags] == SEE ALSO -* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project +* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_metrics.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_metrics.adoc index 1f7bc36a2..f0c87736f 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_metrics.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_metrics.adoc @@ -34,7 +34,7 @@ akka projects observability unset metrics [flags] == SEE ALSO -* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project +* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_traces.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_traces.adoc index cdc9a01ea..ac5ffa74b 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_traces.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_observability_unset_traces.adoc @@ -34,7 +34,7 @@ akka projects observability unset traces [flags] == SEE ALSO -* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project +* link:akka_projects_observability_unset.html[akka projects observability unset] - Unset the observability settings for your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_open.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_open.adoc index d49b9721c..c7bcd81b8 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_open.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_open.adoc @@ -1,6 +1,6 @@ = akka projects open -Opens the current project in the console. +Open the current project in the console. ---- akka projects open [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions.adoc index 30fe6975a..463ca52e5 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions.adoc @@ -1,10 +1,11 @@ = akka projects regions -Manage the regions for your Akka project +Manage the regions assigned to your Akka project. == Synopsis The `akka projects regions` commands manages the regions for your Akka project. +The available regions are the regions assigned to the organization that the project belongs to. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_add.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_add.adoc index 6c46b5954..0d61119bf 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_add.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_add.adoc @@ -35,7 +35,7 @@ akka projects regions add [flags] == SEE ALSO -* link:akka_projects_regions.html[akka projects regions] - Manage the regions for your Akka project +* link:akka_projects_regions.html[akka projects regions] - Manage the regions assigned to your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_list.adoc index ad1a8a160..9e6963764 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_list.adoc @@ -35,7 +35,7 @@ akka projects regions list [flags] == SEE ALSO -* link:akka_projects_regions.html[akka projects regions] - Manage the regions for your Akka project +* link:akka_projects_regions.html[akka projects regions] - Manage the regions assigned to your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_set-primary.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_set-primary.adoc index 82f84ad7f..7616d22a8 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_set-primary.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_regions_set-primary.adoc @@ -35,7 +35,7 @@ akka projects regions set-primary [flags] == SEE ALSO -* link:akka_projects_regions.html[akka projects regions] - Manage the regions for your Akka project +* link:akka_projects_regions.html[akka projects regions] - Manage the regions assigned to your Akka project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens.adoc index 590f498bb..2e95883f4 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens.adoc @@ -1,10 +1,13 @@ = akka projects tokens -Manage your Akka project service tokens +Manage your Akka project service tokens. == Synopsis The `akka projects tokens` commands manipulate the service tokens that have access to your Akka project. +These service tokens are tied to a single project and allow for authenticating and performing actions on that project. +Often used for automation and CI/CD pipelines. +See more details at https://doc.akka.io/operations/integrating-cicd/index.html . == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_create.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_create.adoc index 5ae032999..c5614251f 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_create.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_create.adoc @@ -37,7 +37,7 @@ akka projects tokens create [flags] == SEE ALSO -* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens +* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_list.adoc index 0a9bcca24..ac3c5d9eb 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_list.adoc @@ -35,7 +35,7 @@ akka projects tokens list [flags] == SEE ALSO -* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens +* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_revoke.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_revoke.adoc index ece84453d..5ad3fa575 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_revoke.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_tokens_revoke.adoc @@ -35,7 +35,7 @@ akka projects tokens revoke ID [flags] == SEE ALSO -* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens +* link:akka_projects_tokens.html[akka projects tokens] - Manage your Akka project service tokens. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_regions.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_regions.adoc index e2e1defb8..69620b159 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_regions.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_regions.adoc @@ -1,10 +1,14 @@ = akka regions -Manage regions on Akka +Manage available regions. == Synopsis The `akka regions` commands manage the regions in your Akka account. +The regions are the locations available to which your services can be deployed. +The regions available to you are the regions available to the organization(s) you are part of. + +For more details on regions, see https://doc.akka.io/operations/regions/index.html . == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_regions_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_regions_list.adoc index 085e950be..ca4ab9302 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_regions_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_regions_list.adoc @@ -30,7 +30,7 @@ akka regions list [flags] == SEE ALSO -* link:akka_regions.html[akka regions] - Manage regions on Akka +* link:akka_regions.html[akka regions] - Manage available regions. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_roles.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_roles.adoc index dbbc913c2..9cb61950a 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_roles.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_roles.adoc @@ -5,6 +5,8 @@ Manage the user roles for an Akka project. == Synopsis The `akka roles` commands associate user roles (authorizations) with the current project. +Different roles grant different levels of access to the project. +For details on roles, see https://doc.akka.io/operations/projects/manage-project-access.html . == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_routes.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_routes.adoc index 75a33a52a..7d1778e6c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_routes.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_routes.adoc @@ -5,6 +5,20 @@ Manage routes for your Akka project. == Synopsis The `akka routes` commands manipulate ingress routes for your Akka project. +Routes are used to map incoming requests to services in your project. +Each route has a hostname and a set of paths that map to services. + +== Examples + +---- + +> akka route create my-ecommerce-project \ + --hostname ecommerce.acme.org \ + --path /carts=shopping-cart \ + --path /products=product-info + +For other examples, see https://doc.akka.io/operations/services/invoke-service.html#_managing_routes . +---- == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets.adoc index 67cbfc9e6..fe68be3ef 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets.adoc @@ -5,6 +5,9 @@ Manage secrets for an Akka project. == Synopsis The `akka secrets` command manages secrets for the currently configured project. +These secrets can then be referenced when configuring other properties (e.g. +JWTs) or can be made available to the service as environment variables. +See more details at https://doc.akka.io/operations/projects/secrets.html . == Options @@ -30,7 +33,7 @@ The `akka secrets` command manages secrets for the currently configured project. == SEE ALSO * link:akka.html[akka] - Akka control -* link:akka_secrets_create.html[akka secrets create] - Creates or updates a secret in the current project. +* link:akka_secrets_create.html[akka secrets create] - Create or update a secret in the current project. * link:akka_secrets_delete.html[akka secrets delete] - Delete a secret from the current project. * link:akka_secrets_get.html[akka secrets get] - Get a secret and its keys in the current project. * link:akka_secrets_list.html[akka secrets list] - List the secrets in the current project. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create.adoc index 251af1e97..fbebb4fc1 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create.adoc @@ -1,6 +1,6 @@ = akka secrets create -Creates or updates a secret in the current project. +Create or update a secret in the current project. == Synopsis diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_asymmetric.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_asymmetric.adoc index 89196fb8c..00f25e198 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_asymmetric.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_asymmetric.adoc @@ -47,7 +47,7 @@ akka secrets create asymmetric SECRET_NAME [flags] == SEE ALSO -* link:akka_secrets_create.html[akka secrets create] - Creates or updates a secret in the current project. +* link:akka_secrets_create.html[akka secrets create] - Create or update a secret in the current project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_generic.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_generic.adoc index b7726a2d1..98bb8ec8d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_generic.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_generic.adoc @@ -46,7 +46,7 @@ akka secrets create generic SECRET_NAME [flags] == SEE ALSO -* link:akka_secrets_create.html[akka secrets create] - Creates or updates a secret in the current project. +* link:akka_secrets_create.html[akka secrets create] - Create or update a secret in the current project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_symmetric.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_symmetric.adoc index 8b8fdd4ce..781df1647 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_symmetric.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_symmetric.adoc @@ -46,7 +46,7 @@ akka secrets create symmetric SECRET_NAME [flags] == SEE ALSO -* link:akka_secrets_create.html[akka secrets create] - Creates or updates a secret in the current project. +* link:akka_secrets_create.html[akka secrets create] - Create or update a secret in the current project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls-ca.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls-ca.adoc index 61da6ab99..43e468350 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls-ca.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls-ca.adoc @@ -45,7 +45,7 @@ akka secrets create tls-ca SECRET_NAME [flags] == SEE ALSO -* link:akka_secrets_create.html[akka secrets create] - Creates or updates a secret in the current project. +* link:akka_secrets_create.html[akka secrets create] - Create or update a secret in the current project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls.adoc index 43b2224cb..41e0305b8 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_secrets_create_tls.adoc @@ -47,7 +47,7 @@ akka secrets create tls SECRET_NAME [flags] == SEE ALSO -* link:akka_secrets_create.html[akka secrets create] - Creates or updates a secret in the current project. +* link:akka_secrets_create.html[akka secrets create] - Create or update a secret in the current project. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services.adoc index b67ae24a8..03875b97c 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services.adoc @@ -30,24 +30,24 @@ The `akka services` commands are used to manage and modify the services in your == SEE ALSO * link:akka.html[akka] - Akka control -* link:akka_services_apply.html[akka services apply] - Applies a service descriptor to the currently configured project. -* link:akka_services_components.html[akka services components] - Manage the components of a service. +* link:akka_services_apply.html[akka services apply] - Apply a service descriptor to the currently configured project. +* link:akka_services_components.html[akka services components] - Inspect components of a service. * link:akka_services_connectivity.html[akka services connectivity] - Summarize all services connectivity and status. * link:akka_services_data.html[akka services data] - Manage the data of a service. * link:akka_services_delete.html[akka services delete] - Delete a service. -* link:akka_services_deploy.html[akka services deploy] - Deploys a service to the currently configured project. -* link:akka_services_edit.html[akka services edit] - Edits a service descriptor in the currently configured project. -* link:akka_services_export.html[akka services export] - Exports a service as its service descriptor +* link:akka_services_deploy.html[akka services deploy] - Deploy a service to the currently configured project. +* link:akka_services_edit.html[akka services edit] - Edit a service descriptor in the currently configured project. +* link:akka_services_export.html[akka services export] - Export a service as its service descriptor. * link:akka_services_expose.html[akka services expose] - Expose a service. * link:akka_services_get.html[akka services get] - Describe a specific service. -* link:akka_services_jwts.html[akka services jwts] - Manage JWTs. +* link:akka_services_jwts.html[akka services jwts] - Manage JWT keys of a service. * link:akka_services_list.html[akka services list] - List all services. * link:akka_services_logging.html[akka services logging] - Change the log level configration of a service. -* link:akka_services_pause.html[akka services pause] - Pauses a service, scaling it to zero. +* link:akka_services_pause.html[akka services pause] - Pause a service, scaling it to zero instances. * link:akka_services_proxy.html[akka services proxy] - Create an HTTP proxy to a service. -* link:akka_services_restart.html[akka services restart] - Restarts all service instances using the newest image. -* link:akka_services_restore.html[akka services restore] - Restores a service that was deleted in the past two weeks. -* link:akka_services_resume.html[akka services resume] - Resumes a service, scaling it back up. +* link:akka_services_restart.html[akka services restart] - Restart all service instances using the newest image. +* link:akka_services_restore.html[akka services restore] - Restore a service that was deleted in the past two weeks. +* link:akka_services_resume.html[akka services resume] - Resume a service, scaling it back up. * link:akka_services_unexpose.html[akka services unexpose] - Unexpose a service. * link:akka_services_views.html[akka services views] - Manage views. diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_apply.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_apply.adoc index f475ad1a3..08b076dad 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_apply.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_apply.adoc @@ -1,6 +1,6 @@ = akka services apply -Applies a service descriptor to the currently configured project. +Apply a service descriptor to the currently configured project. == Synopsis diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components.adoc index 94d2beb75..ef086f6c7 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components.adoc @@ -1,6 +1,10 @@ = akka services components -Manage the components of a service. +Inspect components of a service. + +== Synopsis + +The `akka service components` commands provides a way to inspect the components of a service but also to peek at the data stored in the different entities. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-state.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-state.adoc index 5120d2c99..078551cf2 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-state.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-state.adoc @@ -37,7 +37,7 @@ akka services components get-state SERVICE_NAME COMPONENT_NAME ID [flags] == SEE ALSO -* link:akka_services_components.html[akka services components] - Manage the components of a service. +* link:akka_services_components.html[akka services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-workflow.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-workflow.adoc index 915dd9285..e11405a7d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-workflow.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_get-workflow.adoc @@ -37,7 +37,7 @@ akka services components get-workflow SERVICE_NAME COMPONENT_NAME WORKFLOW_ID [f == SEE ALSO -* link:akka_services_components.html[akka services components] - Manage the components of a service. +* link:akka_services_components.html[akka services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-events.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-events.adoc index 5d2469f5f..11b7577a0 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-events.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-events.adoc @@ -41,7 +41,7 @@ akka services components list-events SERVICE_NAME COMPONENT_NAME ENTITY_ID [flag == SEE ALSO -* link:akka_services_components.html[akka services components] - Manage the components of a service. +* link:akka_services_components.html[akka services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-ids.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-ids.adoc index 06d402fa1..cbeb8c57d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-ids.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-ids.adoc @@ -39,7 +39,7 @@ akka services components list-ids SERVICE_NAME COMPONENT_NAME [flags] == SEE ALSO -* link:akka_services_components.html[akka services components] - Manage the components of a service. +* link:akka_services_components.html[akka services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-timers.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-timers.adoc index 28f9d7031..72fdcdac4 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-timers.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list-timers.adoc @@ -41,7 +41,7 @@ akka services components list-timers SERVICE_NAME [flags] == SEE ALSO -* link:akka_services_components.html[akka services components] - Manage the components of a service. +* link:akka_services_components.html[akka services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list.adoc index b7e58ba69..631df68b8 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_components_list.adoc @@ -36,7 +36,7 @@ akka services components list SERVICE [flags] == SEE ALSO -* link:akka_services_components.html[akka services components] - Manage the components of a service. +* link:akka_services_components.html[akka services components] - Inspect components of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_deploy.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_deploy.adoc index d789e9faf..f94eed497 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_deploy.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_deploy.adoc @@ -1,12 +1,14 @@ = akka services deploy -Deploys a service to the currently configured project. +Deploy a service to the currently configured project. == Synopsis The `akka service deploy _service-name_ _docker-image_` command deploys a service with name _service-name_ using the _docker-image_. +This command is meant for rapid experimentation and development. +For production use cases, we recommend deploying through a service descriptor, using the `akka service apply` command. -NOTE: You will need Docker credentials to be set up in order for Akka to be able to pull from your private image repository. +NOTE: If using a private image repository, you will need Docker credentials to be set up in order for Akka to be able to pull from your images. For more info see `akka docker` ---- diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_edit.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_edit.adoc index e540f0ff1..e147bba69 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_edit.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_edit.adoc @@ -1,6 +1,6 @@ = akka services edit -Edits a service descriptor in the currently configured project. +Edit a service descriptor in the currently configured project. == Synopsis diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_export.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_export.adoc index c1bd8c74f..8ef01ab5a 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_export.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_export.adoc @@ -1,6 +1,6 @@ = akka services export -Exports a service as its service descriptor +Export a service as its service descriptor. == Synopsis diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_expose.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_expose.adoc index 4350678bf..827f617dc 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_expose.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_expose.adoc @@ -6,6 +6,8 @@ Expose a service. The `akka services expose _service-name_` command creates a route to expose a service for inbound traffic. You may optionally enable HTTP CORS with the `--enable-cors` flag. +When a _hostname_ is not provided, the service is exposed with a generated hostname. +For more information on exposing services, see https://doc.akka.io/operations/services/invoke-service.html. ---- akka services expose SERVICE [flags] @@ -24,12 +26,12 @@ akka services expose my-service --force-global force an existing regional resource to be configured as a global resource --force-regional force an existing global resource to be configured as a regional resource -h, --help help for expose - --hostname string service route hostname + --hostname string specify a service route hostname --once-per-region expose the service once per region --owner string the owner of the project to use, needed if you have two projects with the same name from different owners --project string project to use if not using the default configured project --region string region to use if project has more than one region - --uri-prefix string service URI prefix (default "/") + --uri-prefix string set a service URI prefix. Incoming requests will be routed to the service only if the URI path starts with this prefix. (default "/") ---- == Options inherited from parent commands diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_get.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_get.adoc index 757bbbde7..644ddc51e 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_get.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_get.adoc @@ -4,7 +4,7 @@ Describe a specific service. == Synopsis -The `akka services get _service-name_` command shows the description of a given service, including container statuses. +The `akka services get _service-name_` command shows the details of a given service, including versions, container image, routes, and other runtime concerns. ---- akka services get SERVICE [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts.adoc index bc133b6a8..ba76d2942 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts.adoc @@ -1,6 +1,6 @@ = akka services jwts -Manage JWTs. +Manage JWT keys of a service. == Options diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_add.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_add.adoc index a296eb3b5..3b997cc45 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_add.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_add.adoc @@ -49,7 +49,7 @@ akka services jwts add [SERVICE] [flags] == SEE ALSO -* link:akka_services_jwts.html[akka services jwts] - Manage JWTs. +* link:akka_services_jwts.html[akka services jwts] - Manage JWT keys of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_generate.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_generate.adoc index f87dbd503..5c7e13be1 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_generate.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_generate.adoc @@ -49,7 +49,7 @@ akka services jwts generate [SERVICE] [flags] == SEE ALSO -* link:akka_services_jwts.html[akka services jwts] - Manage JWTs. +* link:akka_services_jwts.html[akka services jwts] - Manage JWT keys of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list-algorithms.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list-algorithms.adoc index 7a21d92a5..5cc56cc47 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list-algorithms.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list-algorithms.adoc @@ -33,7 +33,7 @@ akka services jwts list-algorithms [flags] == SEE ALSO -* link:akka_services_jwts.html[akka services jwts] - Manage JWTs. +* link:akka_services_jwts.html[akka services jwts] - Manage JWT keys of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list.adoc index ed917f605..b459089bf 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_list.adoc @@ -46,7 +46,7 @@ my-key HS256 my-issuer-name == SEE ALSO -* link:akka_services_jwts.html[akka services jwts] - Manage JWTs. +* link:akka_services_jwts.html[akka services jwts] - Manage JWT keys of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_remove.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_remove.adoc index a176fd82d..5a425d8bd 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_remove.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_remove.adoc @@ -45,7 +45,7 @@ akka services jwts remove [SERVICE] [flags] == SEE ALSO -* link:akka_services_jwts.html[akka services jwts] - Manage JWTs. +* link:akka_services_jwts.html[akka services jwts] - Manage JWT keys of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_update.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_update.adoc index c75f51b4f..4e1c1905d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_update.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_jwts_update.adoc @@ -49,7 +49,7 @@ akka services jwts update [SERVICE] [flags] == SEE ALSO -* link:akka_services_jwts.html[akka services jwts] - Manage JWTs. +* link:akka_services_jwts.html[akka services jwts] - Manage JWT keys of a service. [discrete] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_list.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_list.adoc index 454e0d625..4a484206d 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_list.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_list.adoc @@ -5,6 +5,7 @@ List all services. == Synopsis The `akka services list` command lists a one-line summary of all services under your current project. +By default, it shows information for the primary region of the configured project only. ---- akka services list [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_pause.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_pause.adoc index 24655cb2d..ae520c0ed 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_pause.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_pause.adoc @@ -1,10 +1,11 @@ = akka services pause -Pauses a service, scaling it to zero. +Pause a service, scaling it to zero instances. == Synopsis -The `akka service pause _service-name_` command pauses a service, scaling it to zero but keeping its data. +The `akka service pause _service-name_` command pauses a service, scaling it to zero instances but keeping its data intact. +TIP: To resume the service, use the `akka service resume _service-name_` command. ---- akka services pause SERVICE [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_proxy.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_proxy.adoc index 4c9450bc7..f1954c807 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_proxy.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_proxy.adoc @@ -5,6 +5,7 @@ Create an HTTP proxy to a service. == Synopsis The `akka service proxy` command creates an HTTP proxy that forwards all traffic to the service. +This allows you to interact with the service as if it was running locally. ---- akka services proxy SERVICE [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restart.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restart.adoc index 3a06a6258..0784279f2 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restart.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restart.adoc @@ -1,6 +1,6 @@ = akka services restart -Restarts all service instances using the newest image. +Restart all service instances using the newest image. == Synopsis diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restore.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restore.adoc index cd6ae0f6b..c4171540f 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restore.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_restore.adoc @@ -1,6 +1,6 @@ = akka services restore -Restores a service that was deleted in the past two weeks. +Restore a service that was deleted in the past two weeks. == Synopsis diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_resume.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_resume.adoc index cbe0116b6..9c7f3b874 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_resume.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_resume.adoc @@ -1,10 +1,10 @@ = akka services resume -Resumes a service, scaling it back up. +Resume a service, scaling it back up. == Synopsis -The `akka service resume _service-name_` command resumes a previously paused service, scaling it back up. +The `akka service resume _service-name_` command resumes a previously paused service, scaling it back up to the minimum number of instances configured for the service. ---- akka services resume SERVICE [flags] diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_views.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_views.adoc index 90e8e3f54..5b5a6409e 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_services_views.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_services_views.adoc @@ -2,6 +2,10 @@ Manage views. +== Synopsis + +The `akka service views` commands manage the views for an Akka project, including listing of existing views and deleting views and their data when a view is no longer used. + == Options ---- diff --git a/docs/src/modules/reference/pages/cli/akka-cli/akka_version.adoc b/docs/src/modules/reference/pages/cli/akka-cli/akka_version.adoc index 9fe629af6..de7373fd3 100644 --- a/docs/src/modules/reference/pages/cli/akka-cli/akka_version.adoc +++ b/docs/src/modules/reference/pages/cli/akka-cli/akka_version.adoc @@ -1,6 +1,6 @@ = akka version -Prints the akka version +Print the akka CLI version ---- akka version [flags]