From 7364b4d6f77d4bb873c27d8966b08cbe48d95149 Mon Sep 17 00:00:00 2001 From: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Date: Wed, 9 Aug 2023 13:57:40 -0400 Subject: [PATCH] Adding a section on deploying applications (#650) * Adding a deploying application section * add deploy applications page * Address feedback * Address feedback * Fix typo * Fix typo * Removing the eg o/p * Address comments * Address comments * Fix space * Address feedback * Fix spellcheck * Address feedback * Address typo * Remove spelling * Address feedbac * Update docs/content/deploy-apps/deploy-applications/index.md Co-authored-by: Aaron Crawfis * Update rad init --------- Co-authored-by: Aaron Crawfis --- docs/content/author-apps/_index.md | 6 +-- docs/content/community.md | 2 +- docs/content/contributing/_index.md | 2 +- docs/content/deploy-apps/_index.md | 7 ++++ .../deploy-apps/deploy-applications/index.md | 41 +++++++++++++++++++ .../dev-environment/initialize-environment.md | 6 +-- docs/content/operations/_index.md | 2 +- docs/content/reference/_index.md | 2 +- 8 files changed, 58 insertions(+), 10 deletions(-) create mode 100644 docs/content/deploy-apps/_index.md create mode 100644 docs/content/deploy-apps/deploy-applications/index.md rename docs/content/{author-apps => deploy-apps}/dev-environment/initialize-environment.md (97%) diff --git a/docs/content/author-apps/_index.md b/docs/content/author-apps/_index.md index 1748b1cab..6b95b82bb 100644 --- a/docs/content/author-apps/_index.md +++ b/docs/content/author-apps/_index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Developing applications" -linkTitle: "Developing applications" -description: "Learn how to develop a Radius application" +title: "Authoring applications" +linkTitle: "Authoring applications" +description: "Learn how to author a Radius application" weight: 30 --- \ No newline at end of file diff --git a/docs/content/community.md b/docs/content/community.md index 2b02d75f7..d71a2ef45 100644 --- a/docs/content/community.md +++ b/docs/content/community.md @@ -3,7 +3,7 @@ type: docs title: "Radius Community" linkTitle: "Community" description: "Information about the Radius community" -weight: 85 +weight: 80 --- Welcome to the Radius community. We are currently in a private release phase which is open to Microsoft FTEs and select partners. The team is working on a public preview release which will be announced on this page. diff --git a/docs/content/contributing/_index.md b/docs/content/contributing/_index.md index 81a1f6df9..654a18052 100644 --- a/docs/content/contributing/_index.md +++ b/docs/content/contributing/_index.md @@ -3,7 +3,7 @@ type: docs title: "Contributing to Radius" linkTitle: "Contributing" description: "Guides and requirements for contributing to Radius" -weight: 80 +weight: 70 no_list: true --- diff --git a/docs/content/deploy-apps/_index.md b/docs/content/deploy-apps/_index.md new file mode 100644 index 000000000..7ea7c754a --- /dev/null +++ b/docs/content/deploy-apps/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Deploying applications" +linkTitle: "Deploying applications" +description: "Learn how to deploy a Radius application to an environment" +weight: 40 +--- \ No newline at end of file diff --git a/docs/content/deploy-apps/deploy-applications/index.md b/docs/content/deploy-apps/deploy-applications/index.md new file mode 100644 index 000000000..b2ad1d58a --- /dev/null +++ b/docs/content/deploy-apps/deploy-applications/index.md @@ -0,0 +1,41 @@ +--- +type: docs +title: "Overview: Deploying applications into a Radius environment" +linkTitle: "Deploy applications" +description: "Learn how to deploy a Radius application" +weight: 200 +categories: "Overview" +tags: ["deployments"] +--- + +## Run an application + +Once you have [authored an application]({{< ref author-apps >}}), you can run an application using the [`rad run`]({{< ref rad_run >}}) command. + +```bash + rad run app.bicep + ``` + +This will deploy the application to your environment, create port-forwards for all container ports, and stream container logs to the console. + +## Deploy an application + +An application can be deployed to an environment with [`rad deploy`]({{< ref rad_deploy>}}): + +```bash + rad deploy app.bicep + ``` + This will deploy the application to the created Radius environment. + +### Parameters + +Parameters can be included as part of `rad run` or `rad deploy` via the `-p/--parameters` flag: + +```bash + rad deploy app.bicep -p param1=value1 -p param2=value2 + ``` + + This will deploy the application to the created Radius environment injecting the parameters into the application. + + You can find more examples of deploying applications with parameters [here]({{< ref "rad_deploy#examples" >}}). + \ No newline at end of file diff --git a/docs/content/author-apps/dev-environment/initialize-environment.md b/docs/content/deploy-apps/dev-environment/initialize-environment.md similarity index 97% rename from docs/content/author-apps/dev-environment/initialize-environment.md rename to docs/content/deploy-apps/dev-environment/initialize-environment.md index c41be30ed..4244195bc 100644 --- a/docs/content/author-apps/dev-environment/initialize-environment.md +++ b/docs/content/deploy-apps/dev-environment/initialize-environment.md @@ -3,7 +3,7 @@ type: docs title: "How-To: Setup a development environment" linkTitle: "Developer environments" description: "Learn how to initialize a new Radius development environment" -weight: 200 +weight: 100 categories: "How-To" tags: ["environments"] --- @@ -25,9 +25,9 @@ Radius development environments enable you to quickly get started with Radius an ## How-to: Initialize a new dev environment -1. Initialize a new [Radius environment]({{< ref "operations/environments/overview">}}) with `rad init --dev` command: +1. Initialize a new [Radius environment]({{< ref "operations/environments/overview">}}) with `rad init` command: ```bash - rad init --dev + rad init ``` Select `Yes` to setup the app.bicep in the current directory diff --git a/docs/content/operations/_index.md b/docs/content/operations/_index.md index 06c485cfb..0a0e30083 100644 --- a/docs/content/operations/_index.md +++ b/docs/content/operations/_index.md @@ -3,5 +3,5 @@ type: docs title: "Operating application environments" linkTitle: "Operating environments" description: "Learn about operating Radius environments and apps" -weight: 40 +weight: 50 --- diff --git a/docs/content/reference/_index.md b/docs/content/reference/_index.md index 37c806c18..d2a00814c 100644 --- a/docs/content/reference/_index.md +++ b/docs/content/reference/_index.md @@ -3,5 +3,5 @@ type: docs title: "Radius reference documentation" linkTitle: "Reference" description: "Detailed reference documentation on various Radius components" -weight: 70 +weight: 60 ---