Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add how-to guide on application deletion #655

Merged
merged 32 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
dcb02a5
Adding a deploying application section
Reshrahim Jul 21, 2023
925d166
add deploy applications page
Reshrahim Jul 21, 2023
325e82a
Merge branch 'edge' into reshma/deploy
Reshrahim Jul 21, 2023
6a34d27
Address feedback
Reshrahim Jul 24, 2023
8b4a572
Merge branch 'reshma/deploy' of https://github.com/project-radius/doc…
Reshrahim Jul 24, 2023
34c00d2
Address feedback
Reshrahim Jul 24, 2023
0067b74
Fix typo
Reshrahim Jul 24, 2023
526b998
Fix typo
Reshrahim Jul 24, 2023
bce157b
Removing the eg o/p
Reshrahim Jul 24, 2023
e2bf749
Address comments
Reshrahim Jul 24, 2023
098c00f
Address comments
Reshrahim Jul 24, 2023
a3eb2c0
Fix space
Reshrahim Jul 24, 2023
4328bef
Add a page on deletion
Reshrahim Jul 24, 2023
3f4645d
Fix weight
Reshrahim Jul 24, 2023
c95a0fb
Merge branch 'edge' into reshma/delete
Reshrahim Aug 10, 2023
c23ec90
Add how to guide on delete application
Reshrahim Aug 10, 2023
f74600e
Update docs/content/deploy-apps/delete-applications/index.md
Reshrahim Aug 14, 2023
39e9ec4
Update docs/content/deploy-apps/delete-applications/index.md
Reshrahim Aug 14, 2023
9f671b9
Update docs/content/deploy-apps/delete-applications/index.md
Reshrahim Aug 14, 2023
572d97e
Update docs/content/deploy-apps/delete-applications/index.md
Reshrahim Aug 14, 2023
7fdff3d
Update docs/content/deploy-apps/delete-applications/index.md
Reshrahim Aug 14, 2023
a6c107a
Apply suggestions from code review
Reshrahim Aug 14, 2023
2c0480a
Merge branch 'edge' into reshma/delete
Reshrahim Aug 14, 2023
58f80e8
Add text on existing resource
Reshrahim Aug 14, 2023
d4c8fba
Update docs/content/deploy-apps/deploy-applications/index.md
Reshrahim Aug 14, 2023
f12b1f1
Update the delete command
Reshrahim Aug 14, 2023
f37cde8
Merge branch 'reshma/delete' of https://github.com/project-radius/doc…
Reshrahim Aug 14, 2023
dd2bb32
Fix codetab formatting
Reshrahim Aug 14, 2023
74e6732
Code tab fix
Reshrahim Aug 14, 2023
0ce1d25
change steps as headers
Reshrahim Aug 14, 2023
2c55577
Address feedbac
Reshrahim Aug 16, 2023
e51d4db
Merge branch 'edge' into reshma/delete
Reshrahim Aug 16, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions docs/content/deploy-apps/delete-applications/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
type: docs
title: "How-To: Delete an application from a Radius environment"
linkTitle: "Delete applications"
description: "Learn how to delete a Radius application"
weight: 300
categories: "How-To"
tags: ["delete"]
---

## Pre-requisites
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved

A [deployed application]({{< ref deploy-apps >}}) in a Radius environment.

## Step 1: Delete the Radius application from the environment

You can delete the Radius application using the [`rad app delete`]({{< ref rad_application_delete >}}) command.
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved

```bash
rad app delete <appname>
```

This will delete the following resources from the default Radius environment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This will delete the following resources from the default Radius environment
This will delete:

I don't think we need to call out the behavior of the default environment. If a user deployed their application to a non-default environment they already will know to set that flag. Plus any error message would guide them to the right behavior.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Retaining the environment part for completion.


1. All the resources created by Radius on the Kubernetes cluster under the `default-<app-name>` namespace
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. All the resources created by Radius on the Kubernetes cluster under the `default-<app-name>` namespace
1. All managed resources created from Radius resources (_containers, gateways, etc._)

The namespace would only be default-<app-name> if the environment is setup with the default Kubernetes namespace. We can omit that detail and focus on the managed resources created by Radius.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we referencing Radius resources as managed resources?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I was going back and forth on this. The term we use in the codebase is "rendered resources", but I had gotten feedback that readers may not want to use that term. Was trying to find a term that better describes what's happening without introducing a new "branded" term. Lemme see if I can reword this a little, as I want to describe what's happening without another proper adverb in Radius

2. All the resources provisioned by Recipes

## Step 2: Delete any cloud/platform resources

AWS, Azure, Kubernetes, and any other cloud/platform resources that were deployed alongside your Radius application and not as part of a Recipe or referenced as `existing` resource in your Radius application need to be deleted as a separate step.
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved

{{< tabs Azure AWS Kubernetes >}}

{{% codetab %}}
Azure resources can be deleted via the [Azure portal](https://portal.azure.com/) or the [Azure CLI](https://learn.microsoft.com/cli/azure/resource?view=azure-cli-latest#az-resource-delete).
{{% /codetab %}}

{{% codetab %}}
AWS resources can be deleted via the [AWS console](https://aws.amazon.com/console/) or the [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/cloudcontrol/delete-resource.html).
{{% /codetab %}}

{{% codetab %}}
Kubernetes resources can be deleted via [kubectl delete](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#deleting-resources).
{{% /codetab %}}


2 changes: 1 addition & 1 deletion docs/content/deploy-apps/deploy-applications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Parameters can be included as part of `rad run` or `rad deploy` via the `-p/--pa
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" >}}).
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved


Loading