From f797caaee1fa1ec7c2161072090a3ac1b42d5047 Mon Sep 17 00:00:00 2001 From: Will Tsai <28876888+willtsai@users.noreply.github.com> Date: Wed, 21 Feb 2024 16:33:37 -0800 Subject: [PATCH 1/3] update add radius to existing app tutorial Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com> --- docs/content/tutorials/tutorial-add-radius/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/content/tutorials/tutorial-add-radius/index.md b/docs/content/tutorials/tutorial-add-radius/index.md index 9ec1f3500..5471e9ba6 100644 --- a/docs/content/tutorials/tutorial-add-radius/index.md +++ b/docs/content/tutorials/tutorial-add-radius/index.md @@ -136,7 +136,7 @@ Step 2: Deploy and test the existing Guestbook application using `kubectl` Run this command to view the state of your application using Radius: ```bash - rad app connections -a demo + rad app graph -a demo -g default-demo ``` Since you have not yet added Radius to the application, the `rad` CLI will not recognize your `demo` application and you should see a message in the output similar to: @@ -175,9 +175,9 @@ You will now add Radius to the Guestbook application's Kubernetes deployment man apiVersion: apps/v1 # for k8s versions before 1.9.0 use apps/v1beta2 and before 1.8.0 use extensions/v1beta1 kind: Deployment metadata: - name: frontend - annotations: - rad.app/enabled: 'true' + name: frontend + annotations: + rad.app/enabled: 'true' spec: selector: matchLabels: @@ -192,7 +192,7 @@ You will now add Radius to the Guestbook application's Kubernetes deployment man spec: containers: - name: php-redis - image: gcr.io/google-samples/gb-frontend:v4 + image: ghcr.io/radius-project/gb-frontend:v4 resources: requests: cpu: 100m @@ -258,7 +258,7 @@ You will now add Radius to the Guestbook application's Kubernetes deployment man Now that Radius has been enabled for your application, run this command again: ```bash -rad app connections -a demo +rad app graph -a demo -g default-demo ``` You should see output containing information and status of your newly "radified" application, similar to: From 745fcbb72f72a5c18f2d60e38465e005d2d21704 Mon Sep 17 00:00:00 2001 From: Will Tsai <28876888+willtsai@users.noreply.github.com> Date: Thu, 22 Feb 2024 10:38:41 -0800 Subject: [PATCH 2/3] rebrand rad app connections to rad app graph Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com> --- .../howto-connect-dependencies/index.md | 2 +- docs/content/reference/cli/rad_application.md | 2 +- ...onnections.md => rad_application_graph.md} | 26 +++++++++---------- docs/content/tutorials/new-app/index.md | 12 ++++----- .../tutorials/tutorial-add-radius/index.md | 6 +++-- 5 files changed, 25 insertions(+), 23 deletions(-) rename docs/content/reference/cli/{rad_application_connections.md => rad_application_graph.md} (54%) diff --git a/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md b/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md index 54e22b152..ed13989f6 100644 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md +++ b/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md @@ -51,7 +51,7 @@ Connections from a container to a resource result in environment variables for c Radius Connections are more than just environment variables and configuration. You can also access the "application graph" and understand the connections within your application with the following command: ```bash -rad app connections -a demo +rad app graph -a demo ``` You should see the following output, detailing the connections between the `demo` container and the `db` Redis cache, along with information about the underlying Kubernetes resources running the app: diff --git a/docs/content/reference/cli/rad_application.md b/docs/content/reference/cli/rad_application.md index e1b0fc9cc..9d02f828a 100644 --- a/docs/content/reference/cli/rad_application.md +++ b/docs/content/reference/cli/rad_application.md @@ -30,7 +30,7 @@ Manage Radius Applications ### SEE ALSO * [rad]({{< ref rad.md >}}) - Radius CLI -* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application. +* [rad application graph]({{< ref rad_application_graph.md >}}) - Shows the application graph for an application. * [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius Application * [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications * [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details diff --git a/docs/content/reference/cli/rad_application_connections.md b/docs/content/reference/cli/rad_application_graph.md similarity index 54% rename from docs/content/reference/cli/rad_application_connections.md rename to docs/content/reference/cli/rad_application_graph.md index 8c1c81811..2c60588ef 100644 --- a/docs/content/reference/cli/rad_application_connections.md +++ b/docs/content/reference/cli/rad_application_graph.md @@ -1,32 +1,32 @@ --- type: docs -title: "rad application connections CLI reference" -linkTitle: "rad application connections" -slug: rad_application_connections -url: /reference/cli/rad_application_connections/ -description: "Details on the rad application connections Radius CLI command" +title: "rad application graph CLI reference" +linkTitle: "rad application graph" +slug: rad_application_graph +url: /reference/cli/rad_application_graph/ +description: "Details on the rad application graph Radius CLI command" --- -## rad application connections +## rad application graph -Shows the connections for an application. +Shows the application graph and connections for an application. ### Synopsis -Shows the connections for an application +Shows the application graph and connections for an application ``` -rad application connections [flags] +rad application graph [flags] ``` ### Examples ``` -# Show connections for current application -rad app connections +# Show application graph for current application +rad app graph -# Show connections for specified application -rad app connections my-application +# Show application graph for specified application +rad app graph my-application ``` ### Options diff --git a/docs/content/tutorials/new-app/index.md b/docs/content/tutorials/new-app/index.md index ef4103987..24e8920f1 100644 --- a/docs/content/tutorials/new-app/index.md +++ b/docs/content/tutorials/new-app/index.md @@ -88,10 +88,10 @@ Radius Applications are where all your app's resources and relationships come to - **`environment`** specifies the Radius Environment which the Applications "binds" to at deployment. This is what determines where containers should run (_Kubernetes_) and which namespace to deploy into (_prefixed with "default"_). In this case, the application will be deployed into the `default` Environment that was created by `rad init`. - **`compute`** specifies the hosting platform where running services in the Application will run. In this case, the services will be deployed into the `default-myapp` Kubernetes namespace within the same cluster where Radius is installed. -1. Let's take a look inside the Application to see what's deployed. Run [`rad app connections`]({{< ref rad_application_connections >}}) to print the Application's resources and relationships: +1. Let's take a look inside the Application to see what's deployed. Run [`rad app graph`]({{< ref rad_application_graph >}}) to print the Application's resources and relationships: ```bash - rad app connections + rad app graph ``` You'll see that nothing has been deployed yet and the app is empty: @@ -132,10 +132,10 @@ Radius Applications are where all your app's resources and relationships come to demo Applications.Core/containers ``` -1. Run `rad app connections` again to see the container you just deployed: +1. Run `rad app graph` again to see the container you just deployed: ```bash - rad app connections + rad app graph ``` You should see the container you just deployed, along with the underlying Kubernetes resources that were created to run it: @@ -262,10 +262,10 @@ In addition to containers, you can add dependencies like Redis caches, Dapr Stat 1. Press CTRL+C to terminate the port-forward and log stream. -1. Run `rad app connections` again to see the new dependency: +1. Run `rad app graph` again to see the new dependency: ```bash - rad app connections + rad app graph ``` You should see the container and Mongo database you just deployed, along with the underlying Kubernetes resources that were created to run them: diff --git a/docs/content/tutorials/tutorial-add-radius/index.md b/docs/content/tutorials/tutorial-add-radius/index.md index 5471e9ba6..3e822762c 100644 --- a/docs/content/tutorials/tutorial-add-radius/index.md +++ b/docs/content/tutorials/tutorial-add-radius/index.md @@ -142,7 +142,9 @@ Step 2: Deploy and test the existing Guestbook application using `kubectl` Since you have not yet added Radius to the application, the `rad` CLI will not recognize your `demo` application and you should see a message in the output similar to: ``` - Application "demo" does not exist or has been deleted. + Displaying application: demo + + (empty) ``` ## Step 3: Add Radius to the Guestbook application @@ -192,7 +194,7 @@ You will now add Radius to the Guestbook application's Kubernetes deployment man spec: containers: - name: php-redis - image: ghcr.io/radius-project/gb-frontend:v4 + image: ghcr.io/radius-project/samples/gb-frontend:v4 resources: requests: cpu: 100m From 126755b905137c2ab6c57fd9a7feba68cb4499dd Mon Sep 17 00:00:00 2001 From: Will Tsai <28876888+willtsai@users.noreply.github.com> Date: Thu, 22 Feb 2024 10:58:40 -0800 Subject: [PATCH 3/3] undo rebrand rad app connections to rad app graph Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com> --- .../howto-connect-dependencies/index.md | 2 +- docs/content/reference/cli/rad_application.md | 2 +- ...raph.md => rad_application_connections.md} | 26 +++++++++---------- docs/content/tutorials/new-app/index.md | 12 ++++----- 4 files changed, 21 insertions(+), 21 deletions(-) rename docs/content/reference/cli/{rad_application_graph.md => rad_application_connections.md} (54%) diff --git a/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md b/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md index ed13989f6..54e22b152 100644 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md +++ b/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md @@ -51,7 +51,7 @@ Connections from a container to a resource result in environment variables for c Radius Connections are more than just environment variables and configuration. You can also access the "application graph" and understand the connections within your application with the following command: ```bash -rad app graph -a demo +rad app connections -a demo ``` You should see the following output, detailing the connections between the `demo` container and the `db` Redis cache, along with information about the underlying Kubernetes resources running the app: diff --git a/docs/content/reference/cli/rad_application.md b/docs/content/reference/cli/rad_application.md index 9d02f828a..e1b0fc9cc 100644 --- a/docs/content/reference/cli/rad_application.md +++ b/docs/content/reference/cli/rad_application.md @@ -30,7 +30,7 @@ Manage Radius Applications ### SEE ALSO * [rad]({{< ref rad.md >}}) - Radius CLI -* [rad application graph]({{< ref rad_application_graph.md >}}) - Shows the application graph for an application. +* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application. * [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius Application * [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications * [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details diff --git a/docs/content/reference/cli/rad_application_graph.md b/docs/content/reference/cli/rad_application_connections.md similarity index 54% rename from docs/content/reference/cli/rad_application_graph.md rename to docs/content/reference/cli/rad_application_connections.md index 2c60588ef..8c1c81811 100644 --- a/docs/content/reference/cli/rad_application_graph.md +++ b/docs/content/reference/cli/rad_application_connections.md @@ -1,32 +1,32 @@ --- type: docs -title: "rad application graph CLI reference" -linkTitle: "rad application graph" -slug: rad_application_graph -url: /reference/cli/rad_application_graph/ -description: "Details on the rad application graph Radius CLI command" +title: "rad application connections CLI reference" +linkTitle: "rad application connections" +slug: rad_application_connections +url: /reference/cli/rad_application_connections/ +description: "Details on the rad application connections Radius CLI command" --- -## rad application graph +## rad application connections -Shows the application graph and connections for an application. +Shows the connections for an application. ### Synopsis -Shows the application graph and connections for an application +Shows the connections for an application ``` -rad application graph [flags] +rad application connections [flags] ``` ### Examples ``` -# Show application graph for current application -rad app graph +# Show connections for current application +rad app connections -# Show application graph for specified application -rad app graph my-application +# Show connections for specified application +rad app connections my-application ``` ### Options diff --git a/docs/content/tutorials/new-app/index.md b/docs/content/tutorials/new-app/index.md index 24e8920f1..ef4103987 100644 --- a/docs/content/tutorials/new-app/index.md +++ b/docs/content/tutorials/new-app/index.md @@ -88,10 +88,10 @@ Radius Applications are where all your app's resources and relationships come to - **`environment`** specifies the Radius Environment which the Applications "binds" to at deployment. This is what determines where containers should run (_Kubernetes_) and which namespace to deploy into (_prefixed with "default"_). In this case, the application will be deployed into the `default` Environment that was created by `rad init`. - **`compute`** specifies the hosting platform where running services in the Application will run. In this case, the services will be deployed into the `default-myapp` Kubernetes namespace within the same cluster where Radius is installed. -1. Let's take a look inside the Application to see what's deployed. Run [`rad app graph`]({{< ref rad_application_graph >}}) to print the Application's resources and relationships: +1. Let's take a look inside the Application to see what's deployed. Run [`rad app connections`]({{< ref rad_application_connections >}}) to print the Application's resources and relationships: ```bash - rad app graph + rad app connections ``` You'll see that nothing has been deployed yet and the app is empty: @@ -132,10 +132,10 @@ Radius Applications are where all your app's resources and relationships come to demo Applications.Core/containers ``` -1. Run `rad app graph` again to see the container you just deployed: +1. Run `rad app connections` again to see the container you just deployed: ```bash - rad app graph + rad app connections ``` You should see the container you just deployed, along with the underlying Kubernetes resources that were created to run it: @@ -262,10 +262,10 @@ In addition to containers, you can add dependencies like Redis caches, Dapr Stat 1. Press CTRL+C to terminate the port-forward and log stream. -1. Run `rad app graph` again to see the new dependency: +1. Run `rad app connections` again to see the new dependency: ```bash - rad app graph + rad app connections ``` You should see the container and Mongo database you just deployed, along with the underlying Kubernetes resources that were created to run them: