diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 6e8d43cdb..9ae341118 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -984,6 +984,7 @@ SRE SREs OSI ghcr +sharding png src todoapp @@ -1014,3 +1015,197 @@ sngm nmqpk fluentbit nmqpk +interoperate +ToDo +dfb +vhj +Helming +mv +secretName +bcd +jmgn +xgj +Fs +FsOjYzNzksYWJvcnRDb +JyYTNkN +LmRlbW +Ly +NjM +OQ +PUZhbHNl +VoNi +Yy +ZXIubG +ZjLmNsdXN +ZmFsc +bea +blockOwnerDeletion +cb +cmVkaXM +cmVkaXMtcjV +creationTimestamp +dWg +fb +jYWw +jbHVzdGVyLmxvY +kZW +ownerReferences +resourceVersion +uZWN +uc +uid +vLnN +wPw +yNXRjcnJhM +yZWRpcy +matchLabels +plc +cdf +dcf +Tanzu +Kubevela +curation +Waypoint +Crossplane +GitOps +stateful +DSL +unopinionated +Incubations +HCP +Backstage +DaprSidecarExtension +ContainerProperties +ApplicationProperties +encodings +resourceGroups +RecipeStatus +lastModifiedByType +IfNotPresent +OnFailure +AzureKeyVaultVolumePropertiesKeys +EnvironmentProperties +Readonly +EnvironmentPropertiesRecipes +SystemData +TrackedResourceTags +BicepRecipeProperties +RedisCacheListSecretsResult +restartPolicy +ValueFromProperties +grpc +myserviceroute +VolumeProperties +RecipeProperties +schemaExample +IdentitySettings +lastModifiedBy +RuntimesProperties +HealthProbeProperties +rabbitMQQueues +ResourceStatus +HttpRouteProperties +myroute +KubernetesMetadataExtensionAnnotations +SecretValue +listSecrets +pubSubBroker +KubernetesCompute +SqlDatabase +createdAt +GatewayProperties +SqlDatabaseListSecretsResult +SqlDatabaseProperties +bool +GatewayHostname +statestores +provisioningState +SecretObjectProperties +RedisCacheSecrets +SecretValueProperties +HttpGetHealthProbePropertiesHeaders +ConfigMaps +certType +ContainerPorts +templateVersion +ExtenderResource +sqldatabases +ContainerPropertiesConnections +rabbitmqqueues +RabbitMQSecrets +ResourceReference +DaprStateStoreProperties +IamProperties +KubernetesPodSpec +EphemeralVolume +PersistentVolume +httproutes +myservice +datastores +localId +MongoDatabaseListSecretsResult +radiusManaged +RedisCache +AzureKeyVaultVolumeProperties +createdByType +SecretStoreListSecretsResultData +GatewayRoute +SecretStoreListSecretsResult +lastModifiedAt +TcpHealthProbeProperties +testGroup +RabbitMQQueue +KubernetesNamespaceExtension +pubsubbrokers +StateStore +ExecHealthProbeProperties +ProvidersAzure +mygateway +SqlDatabaseSecrets +DaprPubSubBrokerProperties +geo +RedisCacheProperties +LocalIDs +ManagedIdentity +createdBy +HTTPRoute +SecretStoreProperties +EnvironmentCompute +PubSubBroker +KubernetesMetadataExtension +ContainerPortProperties +CertificateObjectProperties +ContainerVolumes +GatewayTls +HttpGetHealthProbeProperties +AzureKeyVaultVolumePropertiesSecrets +systemData +TerraformRecipeProperties +DictionaryOfRecipeProperties +ProvidersAws +DaprSecretStoreProperties +ConnectionProperties +timeoutSeconds +disableDefaultEnvVars +OutputResource +ExtenderProperties +vhost +mydomain +MongoDatabaseSecrets +MongoDatabaseProperties +TemplateVersion +ContainerEnv +SecretStorePropertiesData +AzureKeyVaultVolumePropertiesCertificates +RabbitMQQueueProperties +KeyObjectProperties +KubernetesRuntimeProperties +RabbitMQListSecretsResult +ManualScalingExtension +PUBLICHOSTNAMEORIP +myhostname +IdentitySettingKind +KubernetesMetadataExtensionLabels +outputResources +SecretStore +plainHTTP diff --git a/.github/workflows/redirect.yml b/.github/workflows/redirect.yml new file mode 100644 index 000000000..0390de50b --- /dev/null +++ b/.github/workflows/redirect.yml @@ -0,0 +1,48 @@ +name: Radius Redirect + +on: + workflow_dispatch: + push: + branches: + - edge + - v*.* + paths: + - 'redirect/**' + - '.github/workflows/redirect.yml' + pull_request: + branches: + - edge + - v*.* + paths: + - 'redirect/**' + - '.github/workflows/redirect.yml' + +jobs: + deploy-website: + name: Deploy Redirect Website + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + submodules: false + - name: Deploy staging site + uses: Azure/static-web-apps-deploy@v1 + with: + azure_static_web_apps_api_token: ${{ secrets.SWA_REDIRECT_TOKEN }} + action: "upload" + app_location: "redirect/src" + skip_api_build: true + skip_app_build: true + + close_pr_site: + name: Close PR Staging Site + if: github.event_name == 'pull_request' && github.event.action == 'closed' + runs-on: ubuntu-latest + steps: + - name: Close Pull Request + id: closepullrequest + uses: Azure/static-web-apps-deploy@v1 + with: + azure_static_web_apps_api_token: ${{ secrets.SWA_REDIRECT_TOKEN }} + action: "close" diff --git a/.github/workflows/validate-bicep.yaml b/.github/workflows/validate-bicep.yaml index 5c1c4679d..d9e275314 100644 --- a/.github/workflows/validate-bicep.yaml +++ b/.github/workflows/validate-bicep.yaml @@ -27,17 +27,11 @@ jobs: steps: - name: Check out repo uses: actions/checkout@v2 - - name: az CLI login - run: | - az login --service-principal \ - --username ${{ secrets.AZURE_SP_TESTS_APPID }} \ - --password ${{ secrets.AZURE_SP_TESTS_PASSWORD }} \ - --tenant ${{ secrets.AZURE_SP_TESTS_TENANTID }} - name: Parse release version and set environment variables run: python ./.github/scripts/get_docs_version.py - name: Download rad-bicep run: | - ./.github/scripts/curl-with-retries.sh https://get.radapp.dev/tools/bicep-extensibility/${{ env.DOCS_CHANNEL }}/linux-x64/rad-bicep --output rad-bicep + oras pull ghcr.io/radius-project/radius/bicep/rad-bicep/linux-x64:latest chmod +x rad-bicep ./rad-bicep --version - name: Verify Bicep files diff --git a/.github/workflows/website.yaml b/.github/workflows/website.yaml index 830cab0e5..3080fa00b 100644 --- a/.github/workflows/website.yaml +++ b/.github/workflows/website.yaml @@ -38,7 +38,6 @@ jobs: repository: radius-project/radius ref: ${{ env.RELEASE_BRANCH }} path: ./radius - token: ${{ secrets.GH_RAD_CI_BOT_PAT }} - name: Setup Node uses: actions/setup-node@v2 with: @@ -122,29 +121,14 @@ jobs: uses: Azure/static-web-apps-deploy@v1 with: azure_static_web_apps_api_token: ${{ secrets.ENV_STATICWEBAPP_TOKEN }} + skip_deploy_on_missing_secrets: true repo_token: ${{ secrets.GITHUB_TOKEN }} action: "upload" app_location: "site/" api_location: "site/" output_location: "" skip_app_build: true - - name: Find SWA Comment - uses: peter-evans/find-comment@v2 - id: fc - if: github.event_name == 'pull_request' - with: - issue-number: ${{ github.event.pull_request.number }} - comment-author: 'github-actions[bot]' - body-includes: 'Azure Static Web Apps:' - direction: last - - name: Update SWA Comment - if: github.event_name == 'pull_request' && steps.fc.outputs.comment-id != '' - uses: peter-evans/create-or-update-comment@v3 - with: - comment-id: ${{ steps.fc.outputs.comment-id }} - body: | - - **Password**: `Radiu$1234` + close_pr_site: name: Close PR Staging Site @@ -159,6 +143,7 @@ jobs: uses: Azure/static-web-apps-deploy@v1 with: azure_static_web_apps_api_token: ${{ secrets.ENV_STATICWEBAPP_TOKEN }} + skip_deploy_on_missing_secrets: true action: "close" algolia_index: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1015e254..f57a8067e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,23 @@ # Contributing to Radius documentation Thank you for your interesting in contributing to the Radius documentation! For more information please refer to [https://docs.radapp.io/community/contributing/docs/](https://docs.radapp.io/community/contributing/docs/) + +## Developer Certificate of Origin + +The Radius project follows the [Developer Certificate of Origin](https://developercertificate.org/). This is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. + +Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages. + +``` +This is my commit message + +Signed-off-by: Random J Developer +``` + +Git even has a -s command line option to append this automatically to your commit message: + +``` +$ git commit -s -m 'This is my commit message' +``` + +Visual Studio Code has a setting, `git.alwaysSignOff` to automatically add a Signed-off-by line to commit messages. Search for "sign-off" in VS Code settings to find it and enable it. diff --git a/README.md b/README.md index 85588b5a0..b364ce4b1 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ The latest release docs are available at https://radapp.io ### Edge docs -Edge docs are available at https://edge.radapp.io +Edge docs are available at https://edge.docs.radapp.io ### Staging docs diff --git a/docs/content/_index.md b/docs/content/_index.md index 9c0f44944..5915cf8c2 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -27,7 +27,7 @@ Radius is a cloud native application platform. It enables developers and IT ope {{< /card >}} {{< /cardpane >}} {{< cardpane >}} - {{< card header="**๐Ÿ’ญ Concepts**" footer="[**Learn the concepts โ†’**]({{< ref tutorials >}})" >}} + {{< card header="**๐Ÿ’ญ Concepts**" footer="[**Learn the concepts โ†’**]({{< ref concepts >}})" >}} Learn about the background and concepts behind Radius with in-depth explanations. We'll cover the main concepts and how Radius works, so you have the broader context to deeply understand Radius and use it most effectively. {{< /card >}} {{< card header="**๐Ÿงพ Reference**" footer="[**Visit reference material โ†’**]({{< ref guides >}})" >}} diff --git a/docs/content/community/_index.md b/docs/content/community/_index.md index f0fd89bda..96daf0a19 100644 --- a/docs/content/community/_index.md +++ b/docs/content/community/_index.md @@ -3,5 +3,5 @@ type: docs title: "Radius Community" linkTitle: "Community" description: "Information about the Radius community" -weight: 80 +weight: 90 --- diff --git a/docs/content/community/contributing/contributing-docs/index.md b/docs/content/community/contributing/contributing-docs/index.md index 15d481cd7..cab4ec1f4 100644 --- a/docs/content/community/contributing/contributing-docs/index.md +++ b/docs/content/community/contributing/contributing-docs/index.md @@ -89,6 +89,26 @@ It's easy to get up and running with a GitHub Codespace. This will give you a fu 3. Navigate to `http://localhost:1313/` +## Developer Certificate of Origin + +The Radius project follows the [Developer Certificate of Origin](https://developercertificate.org/). This is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. + +Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages. + +``` +This is my commit message + +Signed-off-by: Random J Developer +``` + +Git even has a -s command line option to append this automatically to your commit message: + +``` +$ git commit -s -m 'This is my commit message' +``` + +Visual Studio Code has a setting, `git.alwaysSignOff` to automatically add a Signed-off-by line to commit messages. Search for "sign-off" in VS Code settings to find it and enable it. + ## Types of docs There are 5 types of docs in Radius: diff --git a/docs/content/community/contributing/github.md b/docs/content/community/contributing/github.md index 84743cea3..1273f5dfb 100644 --- a/docs/content/community/contributing/github.md +++ b/docs/content/community/contributing/github.md @@ -8,10 +8,6 @@ weight: 200 Radius is a community-driven project that lives on GitHub within the [Radius organization](https://github.com/radius-project). -## Access - -Visit https://aka.ms/ProjectRadius/GitHubAccess to request access to the Radius GitHub organization. - ## Source code The source code for Radius is available on GitHub within the [radius repo](https://github.com/radius-project/radius). diff --git a/docs/content/community/overview.md b/docs/content/community/overview.md index 4bf144fb6..85b143b7d 100644 --- a/docs/content/community/overview.md +++ b/docs/content/community/overview.md @@ -12,34 +12,11 @@ Welcome to the Radius community! The best way to interact with the community is via the Radius Discord server: -{{< button link="https://discord.gg/SRG3ePMKNy" text="Radius Discord" newtab="true" >}} +{{< button link="https://aka.ms/radius/discord" text="Radius Discord" newtab="true" >}} ## Community meetings -Every month we host a community meeting to showcase new features, review upcoming milestones, and engage in a Q&A. -Anyone from the Radius community can participate, present a topic, or host. All are welcome! - -### Meeting link - -The meeting link and details are sent out via email. - -### Present your topic - -To present a specific topic on the next Radius community call start by filling out this short form, [Radius community call presenter sign-up form](https://forms.office.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbRw_b7M-8iE1NkIMvs0xAJFFUQlozVThYSzI4OVhRU0E3NlI0U05GNzZFTi4u). - -### Calendar - -| Date | Topic(s) | Meeting Link | Recording | -|------|----------|--------------|-----------| -| Thursday Feb 16th 9:00am Pacific Time (PST) | v0.17 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-02-16%20Project%20Radius%20Community%20Call.mp4?csf=1&web=1&e=u11ceV) | -| Thursday Mar 16th 9:00am Pacific Time (PST) | v0.18 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-03-16%20Project%20Radius%20Community%20Call.mp4?csf=1&web=1&e=LMW6HE) | -| Thursday Apr 20th 9:00am Pacific Time (PST) | v0.19 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-04-20%20Project%20Radius%20Community%20Call.mp4?csf=1&web=1&e=RCA5Qx) | -| Thursday May 18th 9:00am Pacific Time (PST) | v0.20 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-05-18%20Project%20Radius%20Community%20Call.mp4?csf=1&web=1&e=fKcbzm) | -| Thursday June 15th 9:00am Pacific Time (PST) | v0.21 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-06-15%20Project%20Radius%20Community%20Call.mp4?csf=1&web=1&e=WIRhP5) | -| Thursday July 13th 9:00am Pacific Time (PST) | v0.22 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-07-13%20Project%20Radius%20Community%20Call.mp4?csf=1&web=1&e=v30w8D) | -| Thursday Aug 8th 9:00am Pacific Time (PST) | v0.23 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-08-08%20Project%20Radius%20Community%20Call.mp4?csf=1&web=1&e=6Lew1D&nav=eyJyZWZlcnJhbEluZm8iOnsicmVmZXJyYWxBcHAiOiJTdHJlYW1XZWJBcHAiLCJyZWZlcnJhbFZpZXciOiJTaGFyZURpYWxvZyIsInJlZmVycmFsQXBwUGxhdGZvcm0iOiJXZWIiLCJyZWZlcnJhbE1vZGUiOiJ2aWV3In19) | -| Thursday Aug 31st 9:00am Pacific Time (PST) | v0.24 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-08-31%20Radius%20Community%20Call.mp4?csf=1&web=1&e=YBjiMv&nav=eyJyZWZlcnJhbEluZm8iOnsicmVmZXJyYWxBcHAiOiJTdHJlYW1XZWJBcHAiLCJyZWZlcnJhbFZpZXciOiJTaGFyZURpYWxvZyIsInJlZmVycmFsQXBwUGxhdGZvcm0iOiJXZWIiLCJyZWZlcnJhbE1vZGUiOiJ2aWV3In19) | -| Tuesday, Oct 2nd 9:00am Pacific Time (PST) | v0.25 release | - | [Stream](https://microsoft.sharepoint.com/:v:/r/teams/radius/Shared%20Documents/General/Community%20Calls/2023-10-03%20Radius%20Community%20Call.mp4?csf=1&web=1&e=9iXqbg) +Every month we host a community meeting to showcase new features, review upcoming milestones, and engage in a Q&A. Anyone from the Radius community can participate, present a topic, or host. All are welcome! For the meeting schedule, links, and more information, visit the Radius [community repo](https://github.com/radius-project/community#community-meetings). ## GitHub Issues & repositories diff --git a/docs/content/concepts/api-concept/index.md b/docs/content/concepts/api-concept/index.md index 27a43f918..10930fb4e 100644 --- a/docs/content/concepts/api-concept/index.md +++ b/docs/content/concepts/api-concept/index.md @@ -64,7 +64,7 @@ The common structure of a resource id is the following: ### Root scope -A hierarchical set of key-value pairs that identify the original of the resource. Root scopes answer questions like: +A hierarchical set of key-value pairs that identify the origin of the resource. Root scopes answer questions like: - *"What cloud is this resource from?"* - *"What cloud account contains this resource?"* @@ -201,4 +201,4 @@ AWS: Radius: -- [API Reference]({{< ref resource-schema >}}) \ No newline at end of file +- [API Reference]({{< ref resource-schema >}}) diff --git a/docs/content/concepts/architecture-concept/index.md b/docs/content/concepts/architecture-concept/index.md index 0f28f3bf7..372764235 100644 --- a/docs/content/concepts/architecture-concept/index.md +++ b/docs/content/concepts/architecture-concept/index.md @@ -43,7 +43,7 @@ The service that performs this central functionality in Radius is called the Uni UCP contains functionality for federating with separate resource managers as well as its resource providers. For example UCP can route requests to Azure or AWS to manage resources on those cloud systems. -UCP is a scalable REST API that can function either with a single global shard or using regional sharing. UCP is based on the design principles of the Azure Resource Manager (ARM) control-plane but generalizes to work across multiple clouds and systems. The UCP codebase is fully open-source and was created from scratch as part of the Radius project. UCP is written in Go. +UCP is a scalable REST API that can function either with a single global shard or using regional sharding. UCP is based on the design principles of the Azure Resource Manager (ARM) control-plane but generalizes to work across multiple clouds and systems. The UCP codebase is fully open-source and was created from scratch as part of the Radius project. UCP is written in Go. UCP provides routing and federation with internal and external services: diff --git a/docs/content/concepts/faq/index.md b/docs/content/concepts/faq/index.md new file mode 100644 index 000000000..58925a22d --- /dev/null +++ b/docs/content/concepts/faq/index.md @@ -0,0 +1,181 @@ +--- +type: docs +title: "Frequently asked questions" +linkTitle: "FAQ & Comparisons" +description: "Commonly asked questions about best practices" +weight: 999 +--- + +## General + +### Is Kubernetes required to use Radius? + +Currently yes. Although Radius is architected to run on any platform, today Kubernetes is the only hosting platform for Radius for the Radius control-plane and for containerized workloads. In the future, we plan to support other hosting platforms for serverless platforms. + +### Can I incrementally adopt, or "try out" Radius? + +Yes. The easiest way to add Radius to an existing application is through [Radius annotations](#TODO). Simply add the annotations to your existing Helm chart or Kubernetes YAML and you can use the Radius app graph, connections, and Recipes. [Try the tutorial](#TODO) to learn more. + +### Do I have to self-host Radius? Is there a managed service for Radius? + +Open-source Radius requires that you self-host and run your own Radius instance in your Kubernetes cluster. In the future, we hope for providers to include Radius as a part of their managed service offerings. + +### What languages does Radius support? + +For application code, Radius supports any programming language as long as it is containerized. + +Radius resources (_applications, environments, portable resource_) can be authored in Bicep. See the [Radius resource schema]({{< ref resource-schema >}}) for more details. Additional support for other languages (_like Terraform_) is on our backlog. + +Recipes support both Bicep and Terraform. See the [Recipe docs]({{< ref "/guides/recipes/overview" >}}) for more details. + +### When would/should I use more than one environment? + +Users can employ multiple environments for isolation and organization, for example based on: + +- Permissions (managed at the Resource Group/Subscription level in Azure) +- Purpose (dev vs. prod) +- Difference in hosting (standalone Kubernetes vs Microsoft Azure) +- Multi-region deployments (deploy an application to multiple regions) + +[Workspaces]({{< ref "/guides/operations/workspaces/overview" >}}) can be used to manage multiple environments from one machine. + +## Recipes + +### What resources do Recipes support? + +Recipes currently support the set of [Radius portable resources]({{< ref "/guides/author-apps/portable-resources/overview" >}}): Redis, Mongo, RabbitMQ, SQL, Dapr State Stores, Dapr Secret Stores, Dapr Pub/Sub, and the untyped extender resource. Additional support for other resources (_Azure, AWS, etc._) will come in a future release. + +### What infrastructure can Recipes deploy? + +Radius Recipes support any resources that can be modeled in Bicep, or the AWS, Azure, and Kubernetes Terraform providers. + +### Can I use any Terraform provider with Recipes? + +Terraform Recipes currently support the Azure, AWS, and Kubernetes providers, plus any provider that does not require any credentials or configuration to be passed in (_e.g. Oracle, GCP, etc. are not currently supported_). Support for provider configuration is a high priority we plan to address in an upcoming release. + +### Do developers need write access to a cloud provider (_Azure subscription, AWS account, etc._) to use Recipes? + +No. Recipes are deployed on-behalf-of the Radius Environment so developers do not need any write access to an Azure subscription, resource group, or AWS account. This allows a least-privilege access model to cloud resources and for IT operators to only allow approved IaC templates to be deployed to their cloud environments. + +## Cloud/platform support + +### What AWS services does Radius support? + +Radius Applications can include AWS services that are also supported by the AWS cloud control API. See the [AWS resource library]({{< ref "/guides/author-apps/aws/overview#resource-library" >}}) for the complete list of supported AWS resources. Connections from a Radius container to an AWS resource are not yet supported. Properties such as hostnames, ports, endpoints, and connection strings need to be manually specified as environment variables. Additional support for Connections to AWS resources is on our backlog. + +### What Azure services does Radius support? + +Radius Applications can include any Azure service, with support for direct connections and managed identities. Compute services (Web Apps, Container Apps, App Service, Functions, Logic Apps, and others) can be deployed but cannot currently declare connections to other resources. + +### Does Radius support Google Cloud Platform (GCP)? + +Not yet, but it is on the backlog. + +### Does Radius support Dapr? + +Yes. Radius has first-class support for [Dapr building blocks]({{< ref "/guides/author-apps/dapr" >}}) such as state stores, secret stores, and pub/sub brokers. Developers can add Dapr resources to their applications and operators can define Recipes that deploy and manage the underlying infrastructure. + +## Comparison to other tools + +### How does Radius compare to Kubernetes? + +[Kubernetes](https://kubernetes.io/) is an open-source system for automating deployment, scaling, and management of containerized applications and custom resources. + +Radius leverages Kubernetes in two ways: + +1. As a hosting platform for the Radius control-plane +2. As a runtime for containerized workloads + +While Radius only supports Kubernetes today, it is architected to support other hosting platforms in the future, including serverless platforms. Radius is not a Kubernetes controller and the primary user experience is not through CRDs. Instead, Radius Applications are an abstraction layer on top of Kubernetes and other cloud platforms. + +### How does Radius compare to Helm? + +[Helm](https://helm.sh/) is a package manager for Kubernetes that allows you to define, install, and upgrade Kubernetes applications. Helm is a great tool for deploying Kubernetes objects, but doesn't provide a way to model dependencies between services and infrastructure, or to define and manage infrastructure-as-code. It also only supports Kubernetes as a targeted platform. + +Radius was built to provide a platform for modeling and deploying an entire application, as cloud-native applications are more than just Kubernetes. They include cloud infrastructure, running services, the underlying platforms, and all the connections between them. + +Teams looking to leverage existing Helm charts can use the [Radius annotations and Recipe CRD](#TODO) to add Radius capabilities to their existing application. With just a few annotations, you can add the power of the Radius app graph, connections, and Recipes to your existing Helm chart. + +Teams building or migrating applications on Radius can use Bicep to model their application and deploy to Kubernetes today, as well as future platforms, including serverless platforms. + +### How does Radius compare to Bicep? + +[Bicep](https://github.com/Azure/bicep) is a Domain Specific Language (DSL) for deploying infrastructure declaratively. Radius leverages Bicep as one of its supported languages for defining applications and Recipes. + +Similar to how you can define Azure resources in Bicep, you can define Radius resources in Bicep. + +Radius currently uses a temporary fork of Bicep to add support for the Radius resources, but work is underway to merge extensibility support into the main Bicep repo and eliminate the need for a fork. + +### How does Radius compare to Terraform? + +[Terraform](https://www.terraform.io/) is a tool for building, changing, and versioning infrastructure safely and efficiently. Terraform is a great tool for deploying infrastructure, but doesn't provide a way to model an entire application and the dependencies between services and infrastructure, or act as an abstraction layer for multiple cloud providers. + +Teams looking to leverage existing Terraform modules can use [Recipes]({{< ref "/guides/recipes/overview" >}}) to manage infrastructure provisioning, with the application defined in Bicep. The ability to define Radius applications in Terraform in addition to Bicep is on the roadmap. + +### How does Radius compare to Dapr? + +[Dapr](https://dapr.io/) is a portable, event-driven runtime that makes it easy for developers to build resilient, microservice stateless and stateful applications that run on the cloud and edge. Dapr is a great tool for writing microservice code, but doesn't provide a way to model or deploy an entire application and its infrastructure. + +Radius provides [built-in Dapr support]({{< ref "/guides/author-apps/dapr" >}}) to make it easy to model Dapr building blocks and Dapr-enabled services within your app. Like peanut butter and jelly, Radius and Dapr are better together. + +### How does Radius compare to Acorn? + +[Acorn](https://www.acorn.io/) is a cloud platform to build and share applications ("acorns"). It provides a dev environment with the ability to move to cloud environments as part of a paid service. + +Radius is an open-source project that allows you to model, deploy, and manage applications across multiple cloud providers. Radius is not a hosting platform and is not a paid service. Instead, Radius allows you to host your own Radius environments on your own Kubernetes clusters, and deploy applications to any cloud provider or on-premises infrastructure. Radius also offers Recipes and the Application Graph to allow developers and operators to work together on an application. + +### How does Radius compare to Crossplane? + +[Crossplane](https://crossplane.io/) is an open source Kubernetes add-on that extends any cluster with the ability to provision and manage cloud infrastructure, services, and applications using kubectl, GitOps, or any tool that works with the Kubernetes API. As Radius is unopinionated about how infrastructure is deployed through Recipes, Crossplane could be used within a Recipe. Both Bicep and Terraform modules are able to include Kubernetes resources and Crossplane CRDs. + +Once deployed, Crossplane-managed infrastructure can be included in a Radius application and queried via the Radius application graph. + +### How does Radius compare to Open Application Model (OAM)? + +[OAM](https://oam.dev) is a specification for describing applications so that the application description is separated from the details of how the application is deployed onto and managed by the infrastructure. It originated from the Azure Incubations team from which Radius also originated. + +The key difference between OAM and Radius is that OAM is a spec, whereas Radius is an implementation. The expectation with OAM is that there would be a common spec and if it was successful, there would be multiple (compatible) implementations of OAM for various platforms. [Kubevela](https://github.com/kubevela/kubevela) is one example of an OAM implementation. + +Radius is a new project that takes what we learned from OAM and focuses more on the hosting platforms and the developer/operator experience, not just the spec. With Radius we're providing an implementation that's meant to be re-used and hosted in different scenarios. Right now we're focused on Kubernetes. Radius is also taking a more holistic approach with Radius that's bigger than just compute and networking. We're doing more to work with existing tools like Terraform as well that are outside of Kubernetes. Lastly, Radius puts a lot of emphasis on the developer and operator handoff by building features such as Recipes and Environments that bind an application to different cloud providers and runtime platforms. + +### How does Radius compare to Waypoint? + +[HCP Waypoint](https://developer.hashicorp.com/hcp/docs/waypoint) is a HashiCorp-managed application deployment platform that simplifies the process of deploying applications into your infrastructure and helps you standardize your deployment process. + +While Radius also is able to model and deploy applications, it also provides an application graph and Recipes to offer an end-to-end platform that is application-focused at every stage. Radius is more than an abstraction and deployment automation. The Radius app graph allows teams to understand their entire application and all the dependencies within it, even after an application is deployed. Recipes are also more than template automation. They provide abstraction + encapsulation so developers never are required to directly interact with cloud infrastructure templates or parameters. + +### How does Radius compare to Tanzu? + +[Tanzu](https://tanzu.vmware.com/) is a portfolio of products and services for modernizing applications and infrastructure with a common goal: deliver better software to production, continuously. + +Radius is an open-source project that provides a platform for modeling and deploying applications. Radius is not a paid product or service. Instead, Radius allows you to host your own Radius environments on your own Kubernetes clusters, and deploy applications to any cloud provider or on-premises infrastructure. Radius provides differentiated value through Recipes and the Application Graph. Recipes make it easier for developers and platform engineers/IT engineers to collaborate when building cloud native apps. The Application Graph makes it easier to see all of the various components that make up a cloud native application. + +### How does Radius compare to Backstage? + +[Backstage](https://backstage.io/) is an open platform for building developer portals. It provides a common way to define and manage services, and a central place for developers to discover and connect to those services. + +Radius and the application graph could easily fit into Backstage as a plugin. This is on our backlog and is being explored. + +### How does Radius compare to Azure Deployment Environments? + +[Azure Deployment Environments](https://azure.microsoft.com/products/deployment-environments/) allow developers to quickly spin up infrastructure environments with project-based templates. It handles template curation via catalogs of templates, and provides a self-service experience for developers to deploy and manage their environments without needing direct access to the underlying Azure resource groups. + +Radius Recipes provide a similar experience for developers to deploy and manage infrastructure, but with a few key differences: + +- Recipes are defined on a per-resource basis instead of per-environment. This allows developers to "mix and match" resources in any combination and swap out the backing Recipe depending on which environment they are targeting. +- Recipes support both Bicep and Terraform, allowing operators to leverage existing Terraform modules. +- Recipes support both Azure and AWS, allowing operators to manage infrastructure across multiple cloud providers. + +### How does Radius compare to Azure Arc? + +[Azure Arc](https://azure.microsoft.com/services/azure-arc/) is a set of technologies that extends Azure management and services to any infrastructure. It brings Azure services and management to any infrastructure. + +Radius is an open-source project that provides a platform for modeling and deploying applications that can run across Azure, AWS, or private clouds. Instead of extending an existing cloud platform, Radius is a new platform that sits above existing cloud platforms and provides a consistent way to model and deploy applications across these platforms. + +While there isn't direct support for targeting Azure Arc for Radius containers today, Arc services and infrastructure can be modeled and deployed using [Recipes]({{< ref "/guides/recipes/overview" >}}). + +### How does Radius compare to Azure Container Apps? + +[Azure Container Apps](https://azure.microsoft.com/products/container-apps/) is a service that allows developers to deploy containerized applications to Azure without managing any infrastructure. + +While Radius only supports Kubernetes today, it is architected to support other hosting platforms in the future, including serverless platforms such as Azure Container Apps. Serverless support is on our roadmap. diff --git a/docs/content/concepts/why-radius-concept/index.md b/docs/content/concepts/why-radius-concept/index.md index aa5a2e25d..68add0a2c 100644 --- a/docs/content/concepts/why-radius-concept/index.md +++ b/docs/content/concepts/why-radius-concept/index.md @@ -3,7 +3,7 @@ type: docs title: "Concept: Why Radius?" linkTitle: "Why Radius?" description: "Describes the motivations for creating Radius." -weight: 300 +weight: 100 categories: "Concept" --- diff --git a/docs/content/getting-started/index.md b/docs/content/getting-started/index.md index e2425f0b7..007020c1c 100644 --- a/docs/content/getting-started/index.md +++ b/docs/content/getting-started/index.md @@ -22,6 +22,12 @@ The Radius getting-started guide can be [run **for free** in a GitHub Codespace] [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/radius-project/samples) {{< /alert >}} +{{< alert title="๐Ÿš€ Run in a free GitHub Codespace" color="primary" >}} +The Radius getting-started guide can be [run **for free** in a GitHub Codespace](https://github.blog/changelog/2022-11-09-codespaces-for-free-and-pro-accounts/). Visit the following link to get started in seconds: + +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/radius-project/samples) +{{< /alert >}} + ## 1. Have your Kubernetes cluster handy Radius runs inside [Kubernetes]({{< ref "guides/operations/kubernetes" >}}). However you run Kubernetes, get a cluster ready. diff --git a/docs/content/guides/author-apps/portable-resources/overview/portable-resources.png b/docs/content/guides/author-apps/portable-resources/overview/portable-resources.png index 607bf52b3..300f27aac 100644 Binary files a/docs/content/guides/author-apps/portable-resources/overview/portable-resources.png and b/docs/content/guides/author-apps/portable-resources/overview/portable-resources.png differ diff --git a/docs/content/guides/recipes/overview/index.md b/docs/content/guides/recipes/overview/index.md index 14f7e1b02..9d528831f 100644 --- a/docs/content/guides/recipes/overview/index.md +++ b/docs/content/guides/recipes/overview/index.md @@ -16,10 +16,10 @@ Recipes enable a **separation of concerns** between infrastructure operators and ### Support for multiple IaC languages -| Infrastructure as Code Languages | Recipe Support | -|---------------------| ------------| -| [Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/) | โœ… | -| [Terraform](https://developer.hashicorp.com/terraform/docs) | โœ… | +| Language | Supported sources | Notes | +|----------|-------------------|-------| +| [Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/) | [OCI registries](https://opencontainers.org/) | Supports Azure, AWS, and Kubernetes +| [Terraform](https://developer.hashicorp.com/terraform/docs) | [Public Terraform registries](https://registry.terraform.io/) | Supports Azure, AWS, and Kubernetes providers
Other providers not yet configurable ### Select the Recipe that meets your needs diff --git a/docs/content/reference/_index.md b/docs/content/reference/_index.md index 796a51a47..30d41b833 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: 90 +weight: 100 --- diff --git a/docs/content/reference/cli/rad_application.md b/docs/content/reference/cli/rad_application.md index b0e43281c..e1b0fc9cc 100644 --- a/docs/content/reference/cli/rad_application.md +++ b/docs/content/reference/cli/rad_application.md @@ -35,5 +35,4 @@ Manage Radius Applications * [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications * [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details * [rad application status]({{< ref rad_application_status.md >}}) - Show Radius Application status -* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius Application diff --git a/docs/content/reference/cli/rad_application_switch.md b/docs/content/reference/cli/rad_application_switch.md deleted file mode 100644 index ba7152a8c..000000000 --- a/docs/content/reference/cli/rad_application_switch.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -type: docs -title: "rad application switch CLI reference" -linkTitle: "rad application switch" -slug: rad_application_switch -url: /reference/cli/rad_application_switch/ -description: "Details on the rad application switch Radius CLI command" ---- -## rad application switch - -Switch the default Radius Application - -### Synopsis - -Switches the default Radius Application - -``` -rad application switch [flags] -``` - -### Examples - -``` -rad app switch newApplication -``` - -### Options - -``` - -a, --application string The application name - -h, --help help for switch - -w, --workspace string The workspace name -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -o, --output string output format (supported formats are json, table) (default "table") -``` - -### SEE ALSO - -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications - diff --git a/docs/content/reference/cli/rad_bicep_publish.md b/docs/content/reference/cli/rad_bicep_publish.md index db2a3c5ac..a4aa75441 100644 --- a/docs/content/reference/cli/rad_bicep_publish.md +++ b/docs/content/reference/cli/rad_bicep_publish.md @@ -36,6 +36,7 @@ rad bicep publish --file ./redis-test.bicep --target br:ghcr.io/myregistry/redis ``` --file string path to the local Bicep file, relative to the current working directory. -h, --help help for publish + --plain-http connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS). --target string remote OCI registry path, in the format 'br:HOST/PATH:TAG'. ``` diff --git a/docs/content/reference/cli/rad_install_kubernetes.md b/docs/content/reference/cli/rad_install_kubernetes.md index cfd2502fb..1df499317 100644 --- a/docs/content/reference/cli/rad_install_kubernetes.md +++ b/docs/content/reference/cli/rad_install_kubernetes.md @@ -36,16 +36,20 @@ rad install kubernetes --kubecontext mycluster # Install Radius with overrides in the current Kubernetes context rad install kubernetes --set key=value +# Install Radius with the intermediate root CA certificate in the current Kubernetes context +rad install kubernetes --set-file global.rootCA.cert=/path/to/rootCA.crt + ``` ### Options ``` - --chart string Specify a file path to a helm chart to install Radius from - -h, --help help for kubernetes - --kubecontext string The Kubernetes context to use, will use the default if unset - --reinstall Specify to force reinstallation of Radius - --set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --chart string Specify a file path to a helm chart to install Radius from + -h, --help help for kubernetes + --kubecontext string The Kubernetes context to use, will use the default if unset + --reinstall Specify to force reinstallation of Radius + --set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --set-file stringArray Set values from files on the command line (can specify multiple or separate files with commas: key1=filename1,key2=filename2) ``` ### Options inherited from parent commands diff --git a/docs/content/reference/cli/rad_recipe_register.md b/docs/content/reference/cli/rad_recipe_register.md index 653f49e1f..f22a49ad9 100644 --- a/docs/content/reference/cli/rad_recipe_register.md +++ b/docs/content/reference/cli/rad_recipe_register.md @@ -46,6 +46,7 @@ rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --te -h, --help help for register -o, --output string output format (supported formats are json, table) (default "table") -p, --parameters stringArray Specify parameters for the deployment + --plain-http Connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS). --resource-type string specify the type of the portable resource this recipe can be consumed by --template-kind string specify the kind for the template provided by the recipe. --template-path string specify the path to the template provided by the recipe. diff --git a/docs/content/reference/faq.md b/docs/content/reference/faq.md deleted file mode 100644 index e24d471d6..000000000 --- a/docs/content/reference/faq.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -type: docs -title: "Frequently asked questions" -linkTitle: "FAQ" -description: "Commonly asked questions about best practices" -weight: 999 ---- - -## General - -### Is Kubernetes required to use Radius? - -Currently yes. Today Kubernetes is the only hosting platform for Radius. We are working on additional hosting platforms and container runtimes, so stay tuned for updates. - -### Can I incrementally adopt, or "try out" Radius? - -Yes. Teams can incrementally adopt the Radius platform as they write new applications or add existing applications. Direct connections allow apps with existing platform dependencies (such as Azure and AWS) move to Radius without any code rewrites. Dapr support allows existing Dapr apps to be brought to Radius without any code rewrites as well. Portability and automation can be layered on with Radius portable resources and Recipes. In the future we will add Kubernetes YAML support which enables developers to wrap their existing Kubernetes YAML objects in a Radius container so that they may bring their existing deployments and pods as-is into a Radius Application. - -### Do I have to self-host Radius? Is there a managed service for Radius? - -Open-source Radius requires that you self-host and run your own Radius instance in your Kubernetes cluster. In the future, we hope for providers to include Radius as a part of their managed service offerings. Stay tuned for updates. - -### What languages does Radius support? - -For application code, Radius supports any programming language as long as it is containerized. - -Radius resources (_applications, environments, portable resource_) can be authored in Bicep. See the [Radius resource schema]({{< ref resource-schema >}}) for more details. Additional support for other languages will come in a future release. Stay tuned for updates. - -Recipes support both Bicep and Terraform. See the [Recipe docs]({{< ref "/guides/recipes/overview" >}}) for more details. Additional support for other languages will come in a future release. Stay tuned for updates. - -## Environments - -### Can I connect to an existing environment? - -Yes. When you initialize an environment via `rad init`, you can provide an existing Kubernetes cluster context. Radius will update your `config.yaml` file with the appropriate values. - -### When would/should I use more than one environment? - -Users can employ multiple environments for isolation and organization, for example based on: -- Permissions (managed at the Resource Group/Subscription level in Azure) -- Purpose (dev vs. prod) -- Difference in hosting (standalone Kubernetes vs Microsoft Azure) - -## Recipes - -### What resources can Recipes deploy? - -Radius Recipes support any resources that can be modeled in Bicep, or the AWS, Azure, and Kubernetes Terraform providers. Additional Terraform providers will be offered in an upcoming release. - -### What resources do Recipes support? - -Recipes currently support the set of Radius portable resources: Redis, Mongo, RabbitMQ, SQL, Dapr State Stores, Dapr Secret Stores, Dapr Pub/Sub, the untyped extender resource, and more to come in the future. See the [Radius resource schema]({{< ref resource-schema >}}) for more details. Additional support for other resources (Azure, AWS, etc.) will come in a future release. Stay tuned for updates. - -### Do developers need contributor or owner access to a cloud provider (Azure subscription, AWS account, etc.) to leverage Radius Recipes? - -No. Recipes are deployed on-behalf-of the Radius Environment so developers do not need any write access to an Azure subscription, resource group, or AWS account. This allows a least-privilege access model to cloud resources and for IT operators to only allow approved IaC templates to be deployed to their cloud environments. - -### Why do I need to manually output a Kubernetes UCP ID as part of my Bicep Recipe? - -The Bicep deployment engine currently does not output Kubernetes resource (UCP) IDs upon completion, meaning Recipes cannot automatically link a Recipe-enabled resource to the underlying infrastructure. This also means Kubernetes resources are not automatically cleaned up when a Recipe-enabled resource is deleted. - -To fix this, you can manually build and output UCP IDs, which will cause the infrastructure to be linked to the resource: - -```bicep -import kubernetes as k8s { - kubeConfig: '' - namespace: 'default' -} - -resource deployment 'apps/Deployment@v1' = {...} - -resource service 'core/Service@v1' = {...} - -output values object = { - resources: [ - // Manually build UCP IDs (/planes//local/namespaces//providers///) - '/planes/kubernetes/local/namespaces/${deployment.metadata.namespace}/providers/apps/Deployment/${deployment.metadata.name}' - '/planes/kubernetes/local/namespaces/${service.metadata.namespace}/providers/core/Service/${service.metadata.name}' - ] -} -``` - -## Bicep templates - -### Can one bicep file represent more than one application? - -Yes. You can have multiple application resources defined in one file. - -### Can a bicep file represent something other than applications? - -Yes. Bicep files can contain both Radius resources and Azure resources. Everything in a Bicep file becomes an ARM deployment. - -## Resources - -### Can I modify a resource after it's been deployed? - -Yes. You will need to modify the resource definition in your .bicep file's application definition and re-deploy the application. - -### What AWS services does Radius support - -Radius Applications can include AWS services that are also supported by the AWS cloud control API. See the [AWS resource library]({{< ref "/guides/author-apps/aws/overview#resource-library" >}}) for the complete list of supported AWS resources. Radius does not currently support direct connections to AWS resources, but it is on the backlog. Stay tuned for updates. - -### What Azure services does Radius support? - -Radius Applications can include any non-compute Azure service, with support for direct connections and managed identities. Compute services (Web Apps, Container Apps, App Service, Functions, Logic Apps, and others) will be added in a future release. - -### Does Radius support Google Cloud Platform (GCP)? - -Not yet, but it is on the backlog. Stay tuned for updates. - -### Does Radius support Dapr? - -Yes. Radius has first-class support for Dapr building blocks such as state stores, secret stores, and pub/sub brokers. Developers can add Dapr resources to their applications and operators can define Recipes that deploy and manage the underlying infrastructure. diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md index 3b7d0ddd9..c6d3eb56f 100644 --- a/docs/content/reference/limitations.md +++ b/docs/content/reference/limitations.md @@ -56,6 +56,33 @@ When running `rad env show`, the `lastmodifiedat` and `createdat` fields display This will be addressed in an upcoming release. +## Recipes + +### Kubernetes Bicep resources require manual UCP ID output + +The Bicep deployment engine currently does not output Kubernetes resource (UCP) IDs upon completion, meaning Recipes cannot automatically link a Recipe-enabled resource to the underlying infrastructure. This also means Kubernetes resources are not automatically cleaned up when a Recipe-enabled resource is deleted. + +To fix this, you can manually build and output UCP IDs, which will cause the infrastructure to be linked to the resource: + +```bicep +import kubernetes as k8s { + kubeConfig: '' + namespace: 'default' +} + +resource deployment 'apps/Deployment@v1' = {...} + +resource service 'core/Service@v1' = {...} + +output values object = { + resources: [ + // Manually build UCP IDs (/planes//local/namespaces//providers///) + '/planes/kubernetes/local/namespaces/${deployment.metadata.namespace}/providers/apps/Deployment/${deployment.metadata.name}' + '/planes/kubernetes/local/namespaces/${service.metadata.namespace}/providers/core/Service/${service.metadata.name}' + ] +} +``` + ## Bicep & Deployment Engine ### Currently using a forked version of Bicep diff --git a/docs/content/reference/resource-schema/aws/index.md b/docs/content/reference/resource-schema/aws/index.md index a9c1d64de..995997ca7 100644 --- a/docs/content/reference/resource-schema/aws/index.md +++ b/docs/content/reference/resource-schema/aws/index.md @@ -10,8 +10,6 @@ Radius supports AWS resource types that are supported by the [AWS Cloud Control Following table lists the resource types that are currently supported and the limitations for each of the resource types. -> *If you don't have access to the Bicep-types-aws github repo, please visit https://aka.ms/ProjectRadius/GitHubAccess to request access to the Radius GitHub organization.* - | Resource Type | Notes | | ------------- | ----- | | **[AWS::ACMPCA::Certificate](https://github.com/radius-project/bicep-types-aws/blob/main/artifacts/bicep/aws/aws.acmpca/default/types.md)** | โš  This resource type is non-idempotent. See [here](https://github.com/radius-project/bicep-types-aws/blob/main/docs/reference/limitations.md) for more information. | diff --git a/docs/content/reference/resources/applications/_index.md b/docs/content/reference/resources/applications/_index.md new file mode 100644 index 000000000..133f42c0e --- /dev/null +++ b/docs/content/reference/resources/applications/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: applications" +linkTitle: "applications" +description: "Detailed reference documentation for applications" +--- + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/_index.md new file mode 100644 index 000000000..af94c70a6 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: 2023-10-01-preview" +linkTitle: "2023-10-01-preview" +description: "Detailed reference documentation for 2023-10-01-preview" +--- + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md new file mode 100644 index 000000000..14b831e42 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md @@ -0,0 +1,191 @@ +--- +type: docs +title: "Reference: applications.core/applications@2023-10-01-preview" +linkTitle: "applications" +description: "Detailed reference documentation for applications.core/applications@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [ApplicationProperties](#applicationproperties) | Application properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/applications' | The resource type
_(read-only, deploy-time constant)_ | + +### ApplicationProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(required)_ | +| **extensions** | [Extension](#extension)[] | The application extension. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | + +### Extension + +* **Discriminator**: kind + +#### Base Properties + +* **none** + + +#### DaprSidecarExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(required)_ | +| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | +| **config** | string | Specifies the Dapr configuration to use for the resource. | +| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(required)_ | +| **protocol** | 'grpc' | 'http' | The Dapr sidecar extension protocol | + +#### KubernetesMetadataExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **annotations** | [KubernetesMetadataExtensionAnnotations](#kubernetesmetadataextensionannotations) | Annotations to be applied to the Kubernetes resources output by the resource | +| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(required)_ | +| **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | + +#### KubernetesNamespaceExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(required)_ | +| **namespace** | string | The namespace of the application environment.
_(required)_ | + +#### ManualScalingExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'manualScaling' | Discriminator property for Extension.
_(required)_ | +| **replicas** | int | Replica count.
_(required)_ | + + +### KubernetesMetadataExtensionAnnotations + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### KubernetesMetadataExtensionLabels + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md new file mode 100644 index 000000000..bab914de7 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md @@ -0,0 +1,405 @@ +--- +type: docs +title: "Reference: applications.core/containers@2023-10-01-preview" +linkTitle: "containers" +description: "Detailed reference documentation for applications.core/containers@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [ContainerProperties](#containerproperties) | Container properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/containers' | The resource type
_(read-only, deploy-time constant)_ | + +### ContainerProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **connections** | [ContainerPropertiesConnections](#containerpropertiesconnections) | Specifies a connection to another resource. | +| **container** | [Container](#container) | Definition of a container
_(required)_ | +| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | +| **extensions** | [Extension](#extension)[] | Extensions spec of the resource | +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'internal', where Radius manages the lifecycle of the resource internally, and 'manual', where a user manages the resource. | +| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the container | +| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | Restart policy for the container | +| **runtimes** | [RuntimesProperties](#runtimesproperties) | The properties for runtime configuration | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | + +### ContainerPropertiesConnections + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [ConnectionProperties](#connectionproperties) + +### ConnectionProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **disableDefaultEnvVars** | bool | default environment variable override | +| **iam** | [IamProperties](#iamproperties) | IAM properties | +| **source** | string | The source of the connection
_(required)_ | + +### IamProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure' | The kind of IAM provider to configure
_(required)_ | +| **roles** | string[] | RBAC permissions to be assigned on the source resource | + +### Container + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **args** | string[] | Arguments to the entrypoint. Overrides the container image's CMD | +| **command** | string[] | Entrypoint array. Overrides the container image's ENTRYPOINT | +| **env** | [ContainerEnv](#containerenv) | environment | +| **image** | string | The registry and image to download and run in your container
_(required)_ | +| **imagePullPolicy** | 'Always' | 'IfNotPresent' | 'Never' | The image pull policy for the container | +| **livenessProbe** | [HealthProbeProperties](#healthprobeproperties) | Properties for readiness/liveness probe | +| **ports** | [ContainerPorts](#containerports) | container ports | +| **readinessProbe** | [HealthProbeProperties](#healthprobeproperties) | Properties for readiness/liveness probe | +| **volumes** | [ContainerVolumes](#containervolumes) | container volumes | +| **workingDir** | string | Working directory for the container | + +### ContainerEnv + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### HealthProbeProperties + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **failureThreshold** | int | Threshold number of times the probe fails after which a failure would be reported | +| **initialDelaySeconds** | int | Initial delay in seconds before probing for readiness/liveness | +| **periodSeconds** | int | Interval for the readiness/liveness probe in seconds | +| **timeoutSeconds** | int | Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds | + +#### ExecHealthProbeProperties + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **command** | string | Command to execute to probe readiness/liveness
_(required)_ | +| **kind** | 'exec' | Discriminator property for HealthProbeProperties.
_(required)_ | + +#### HttpGetHealthProbeProperties + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **containerPort** | int | The listening port number
_(required)_ | +| **headers** | [HttpGetHealthProbePropertiesHeaders](#httpgethealthprobepropertiesheaders) | Custom HTTP headers to add to the get request | +| **kind** | 'httpGet' | Discriminator property for HealthProbeProperties.
_(required)_ | +| **path** | string | The route to make the HTTP request on
_(required)_ | + +#### TcpHealthProbeProperties + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **containerPort** | int | The listening port number
_(required)_ | +| **kind** | 'tcp' | Discriminator property for HealthProbeProperties.
_(required)_ | + + +### HttpGetHealthProbePropertiesHeaders + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### ContainerPorts + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [ContainerPortProperties](#containerportproperties) + +### ContainerPortProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **containerPort** | int | The listening port number
_(required)_ | +| **port** | int | Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired | +| **protocol** | 'TCP' | 'UDP' | The protocol in use by the port | +| **provides** | string | Specifies a route provided by this port | +| **scheme** | string | Specifies the URL scheme of the communication protocol. Consumers can use the scheme to construct a URL. The value defaults to 'http' or 'https' depending on the port value | + +### ContainerVolumes + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [Volume](#volume) + +### Volume + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **mountPath** | string | The path where the volume is mounted | + +#### EphemeralVolume + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'ephemeral' | Discriminator property for Volume.
_(required)_ | +| **managedStore** | 'disk' | 'memory' | The managed store for the ephemeral volume
_(required)_ | + +#### PersistentVolume + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'persistent' | Discriminator property for Volume.
_(required)_ | +| **permission** | 'read' | 'write' | The persistent volume permission | +| **source** | string | The source of the volume
_(required)_ | + + +### Extension + +* **Discriminator**: kind + +#### Base Properties + +* **none** + + +#### DaprSidecarExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(required)_ | +| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | +| **config** | string | Specifies the Dapr configuration to use for the resource. | +| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(required)_ | +| **protocol** | 'grpc' | 'http' | The Dapr sidecar extension protocol | + +#### KubernetesMetadataExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **annotations** | [KubernetesMetadataExtensionAnnotations](#kubernetesmetadataextensionannotations) | Annotations to be applied to the Kubernetes resources output by the resource | +| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(required)_ | +| **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | + +#### KubernetesNamespaceExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(required)_ | +| **namespace** | string | The namespace of the application environment.
_(required)_ | + +#### ManualScalingExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'manualScaling' | Discriminator property for Extension.
_(required)_ | +| **replicas** | int | Replica count.
_(required)_ | + + +### KubernetesMetadataExtensionAnnotations + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### KubernetesMetadataExtensionLabels + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### ResourceReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | Resource id of an existing resource
_(required)_ | + +### RuntimesProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kubernetes** | [KubernetesRuntimeProperties](#kubernetesruntimeproperties) | The runtime configuration properties for Kubernetes | + +### KubernetesRuntimeProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **base** | string | The serialized YAML manifest which represents the base Kubernetes resources to deploy, such as Deployment, Service, ServiceAccount, Secrets, and ConfigMaps. | +| **pod** | [KubernetesPodSpec](#kubernetespodspec) | A strategic merge patch that will be applied to the PodSpec object when this container is being deployed. | + +### KubernetesPodSpec + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: any + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md new file mode 100644 index 000000000..2aba7caff --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md @@ -0,0 +1,238 @@ +--- +type: docs +title: "Reference: applications.core/environments@2023-10-01-preview" +linkTitle: "environments" +description: "Detailed reference documentation for applications.core/environments@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [EnvironmentProperties](#environmentproperties) | Environment properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/environments' | The resource type
_(read-only, deploy-time constant)_ | + +### EnvironmentProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource
_(required)_ | +| **extensions** | [Extension](#extension)[] | The environment extension. | +| **providers** | [Providers](#providers) | The Cloud providers configuration | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipes** | [EnvironmentPropertiesRecipes](#environmentpropertiesrecipes) | Specifies Recipes linked to the Environment. | +| **simulated** | bool | Simulated environment. | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### Extension + +* **Discriminator**: kind + +#### Base Properties + +* **none** + + +#### DaprSidecarExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(required)_ | +| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | +| **config** | string | Specifies the Dapr configuration to use for the resource. | +| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(required)_ | +| **protocol** | 'grpc' | 'http' | The Dapr sidecar extension protocol | + +#### KubernetesMetadataExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **annotations** | [KubernetesMetadataExtensionAnnotations](#kubernetesmetadataextensionannotations) | Annotations to be applied to the Kubernetes resources output by the resource | +| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(required)_ | +| **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | + +#### KubernetesNamespaceExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(required)_ | +| **namespace** | string | The namespace of the application environment.
_(required)_ | + +#### ManualScalingExtension + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'manualScaling' | Discriminator property for Extension.
_(required)_ | +| **replicas** | int | Replica count.
_(required)_ | + + +### KubernetesMetadataExtensionAnnotations + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### KubernetesMetadataExtensionLabels + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### Providers + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider definition | +| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider definition | + +### ProvidersAws + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **scope** | string | Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'
_(required)_ | + +### ProvidersAzure + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **scope** | string | Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'
_(required)_ | + +### EnvironmentPropertiesRecipes + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [DictionaryOfRecipeProperties](#dictionaryofrecipeproperties) + +### DictionaryOfRecipeProperties + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [RecipeProperties](#recipeproperties) + +### RecipeProperties + +* **Discriminator**: templateKind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **parameters** | any | Any object | +| **templatePath** | string | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
_(required)_ | + +#### BicepRecipeProperties + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **plainHTTP** | bool | Connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS). | +| **templateKind** | 'bicep' | Discriminator property for RecipeProperties.
_(required)_ | + +#### TerraformRecipeProperties + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | 'terraform' | Discriminator property for RecipeProperties.
_(required)_ | +| **templateVersion** | string | Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources. | + + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md new file mode 100644 index 000000000..80c555d7a --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md @@ -0,0 +1,143 @@ +--- +type: docs +title: "Reference: applications.core/extenders@2023-10-01-preview" +linkTitle: "extenders" +description: "Detailed reference documentation for applications.core/extenders@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [ExtenderProperties](#extenderproperties) | ExtenderResource portable resource properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/extenders' | The resource type
_(read-only, deploy-time constant)_ | + +### Function listSecrets (Applications.Core/extenders@2023-10-01-preview) + +* **Resource**: Applications.Core/extenders +* **ApiVersion**: 2023-10-01-preview +* **Input**: any +* **Output**: any + +### ExtenderProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **secrets** | any | Any object | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +#### Additional Properties + +* **Additional Properties Type**: any + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md new file mode 100644 index 000000000..4452cb885 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md @@ -0,0 +1,155 @@ +--- +type: docs +title: "Reference: applications.core/gateways@2023-10-01-preview" +linkTitle: "gateways" +description: "Detailed reference documentation for applications.core/gateways@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [GatewayProperties](#gatewayproperties) | Gateway properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/gateways' | The resource type
_(read-only, deploy-time constant)_ | + +### GatewayProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | +| **hostname** | [GatewayHostname](#gatewayhostname) | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io. | +| **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet). | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(required)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **tls** | [GatewayTls](#gatewaytls) | TLS configuration definition for Gateway resource. | +| **url** | string | URL of the gateway resource. Readonly
_(read-only)_ | + +### GatewayHostname + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **fullyQualifiedHostname** | string | Specify a fully-qualified domain name: myapp.mydomain.com. Mutually exclusive with 'prefix' and will take priority if both are defined. | +| **prefix** | string | Specify a prefix for the hostname: myhostname.myapp.PUBLICHOSTNAMEORIP.nip.io. Mutually exclusive with 'fullyQualifiedHostname' and will be overridden if both are defined. | + +### GatewayRoute + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **destination** | string | The HttpRoute to route to. Ex - myserviceroute.id. | +| **path** | string | The path to match the incoming request path on. Ex - /myservice. | +| **replacePrefix** | string | Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will transform '/myservice/myroute' to '/myroute' | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### GatewayTls + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **certificateFrom** | string | The resource id for the secret containing the TLS certificate and key for the gateway. | +| **minimumProtocolVersion** | '1.2' | '1.3' | Tls Minimum versions for Gateway resource. | +| **sslPassthrough** | bool | If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/httproutes/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/httproutes/index.md new file mode 100644 index 000000000..ad5bfb79e --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/httproutes/index.md @@ -0,0 +1,125 @@ +--- +type: docs +title: "Reference: applications.core/httproutes@2023-10-01-preview" +linkTitle: "httproutes" +description: "Detailed reference documentation for applications.core/httproutes@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [HttpRouteProperties](#httprouteproperties) | HTTPRoute properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/httpRoutes' | The resource type
_(read-only, deploy-time constant)_ | + +### HttpRouteProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | +| **hostname** | string | The internal hostname accepting traffic for the HTTP Route. Readonly. | +| **port** | int | The port number for the HTTP Route. Defaults to 80. Readonly. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **scheme** | string | The scheme used for traffic. Readonly.
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **url** | string | A stable URL that that can be used to route traffic to a resource. Readonly.
_(read-only)_ | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md new file mode 100644 index 000000000..1bcb23c90 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md @@ -0,0 +1,179 @@ +--- +type: docs +title: "Reference: applications.core/secretstores@2023-10-01-preview" +linkTitle: "secretstores" +description: "Detailed reference documentation for applications.core/secretstores@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [SecretStoreProperties](#secretstoreproperties) | The properties of SecretStore | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/secretStores' | The resource type
_(read-only, deploy-time constant)_ | + +### Function listSecrets (Applications.Core/secretStores@2023-10-01-preview) + +* **Resource**: Applications.Core/secretStores +* **ApiVersion**: 2023-10-01-preview +* **Input**: any +* **Output**: [SecretStoreListSecretsResult](#secretstorelistsecretsresult) + +### SecretStoreProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **data** | [SecretStorePropertiesData](#secretstorepropertiesdata) | An object to represent key-value type secrets
_(required)_ | +| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **resource** | string | The resource id of external secret store. | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **type** | 'certificate' | 'generic' | The type of SecretStore data | + +### SecretStorePropertiesData + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [SecretValueProperties](#secretvalueproperties) + +### SecretValueProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **encoding** | 'base64' | 'raw' | The type of SecretValue Encoding | +| **value** | string | The value of secret. | +| **valueFrom** | [ValueFromProperties](#valuefromproperties) | The Secret value source properties | + +### ValueFromProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the referenced secret.
_(required)_ | +| **version** | string | The version of the referenced secret. | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### SecretStoreListSecretsResult + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **data** | [SecretStoreListSecretsResultData](#secretstorelistsecretsresultdata) | An object to represent key-value type secrets
_(read-only)_ | +| **type** | 'certificate' | 'generic' | The type of SecretStore data
_(read-only)_ | + +### SecretStoreListSecretsResultData + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [SecretValueProperties](#secretvalueproperties) + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md new file mode 100644 index 000000000..3ffea7e2c --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md @@ -0,0 +1,200 @@ +--- +type: docs +title: "Reference: applications.core/volumes@2023-10-01-preview" +linkTitle: "volumes" +description: "Detailed reference documentation for applications.core/volumes@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [VolumeProperties](#volumeproperties) | Volume properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Core/volumes' | The resource type
_(read-only, deploy-time constant)_ | + +### VolumeProperties + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **environment** | string | Fully qualified resource ID for the environment that the application is linked to | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | + +#### AzureKeyVaultVolumeProperties + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **certificates** | [AzureKeyVaultVolumePropertiesCertificates](#azurekeyvaultvolumepropertiescertificates) | The KeyVault certificates that this volume exposes | +| **keys** | [AzureKeyVaultVolumePropertiesKeys](#azurekeyvaultvolumepropertieskeys) | The KeyVault keys that this volume exposes | +| **kind** | 'azure.com.keyvault' | Discriminator property for VolumeProperties.
_(required)_ | +| **resource** | string | The ID of the keyvault to use for this volume resource
_(required)_ | +| **secrets** | [AzureKeyVaultVolumePropertiesSecrets](#azurekeyvaultvolumepropertiessecrets) | The KeyVault secrets that this volume exposes | + + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### AzureKeyVaultVolumePropertiesCertificates + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [CertificateObjectProperties](#certificateobjectproperties) + +### CertificateObjectProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **alias** | string | File name when written to disk | +| **certType** | 'certificate' | 'privatekey' | 'publickey' | Represents certificate types | +| **encoding** | 'base64' | 'hex' | 'utf-8' | Represents secret encodings | +| **format** | 'pem' | 'pfx' | Represents certificate formats | +| **name** | string | The name of the certificate
_(required)_ | +| **version** | string | Certificate version | + +### AzureKeyVaultVolumePropertiesKeys + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [KeyObjectProperties](#keyobjectproperties) + +### KeyObjectProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **alias** | string | File name when written to disk | +| **name** | string | The name of the key
_(required)_ | +| **version** | string | Key version | + +### AzureKeyVaultVolumePropertiesSecrets + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: [SecretObjectProperties](#secretobjectproperties) + +### SecretObjectProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **alias** | string | File name when written to disk | +| **encoding** | 'base64' | 'hex' | 'utf-8' | Represents secret encodings | +| **name** | string | The name of the secret
_(required)_ | +| **version** | string | secret version | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.core/_index.md b/docs/content/reference/resources/applications/applications.core/_index.md new file mode 100644 index 000000000..bc08314e3 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.core/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: applications.core" +linkTitle: "applications.core" +description: "Detailed reference documentation for applications.core" +--- + diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/_index.md new file mode 100644 index 000000000..af94c70a6 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: 2023-10-01-preview" +linkTitle: "2023-10-01-preview" +description: "Detailed reference documentation for 2023-10-01-preview" +--- + diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md new file mode 100644 index 000000000..4b7366fac --- /dev/null +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md @@ -0,0 +1,145 @@ +--- +type: docs +title: "Reference: applications.dapr/pubsubbrokers@2023-10-01-preview" +linkTitle: "pubsubbrokers" +description: "Detailed reference documentation for applications.dapr/pubsubbrokers@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [DaprPubSubBrokerProperties](#daprpubsubbrokerproperties) | Dapr PubSubBroker portable resource properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Dapr/pubSubBrokers' | The resource type
_(read-only, deploy-time constant)_ | + +### DaprPubSubBrokerProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(read-only)_ | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **metadata** | any | Any object | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the pubSubBroker | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | +| **version** | string | Dapr component version | + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | Resource id of an existing resource
_(required)_ | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md new file mode 100644 index 000000000..30a0fb03d --- /dev/null +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md @@ -0,0 +1,136 @@ +--- +type: docs +title: "Reference: applications.dapr/secretstores@2023-10-01-preview" +linkTitle: "secretstores" +description: "Detailed reference documentation for applications.dapr/secretstores@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [DaprSecretStoreProperties](#daprsecretstoreproperties) | Dapr SecretStore portable resource properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Dapr/secretStores' | The resource type
_(read-only, deploy-time constant)_ | + +### DaprSecretStoreProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(read-only)_ | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **metadata** | any | Any object | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | +| **version** | string | Dapr component version | + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md new file mode 100644 index 000000000..796ac148a --- /dev/null +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md @@ -0,0 +1,145 @@ +--- +type: docs +title: "Reference: applications.dapr/statestores@2023-10-01-preview" +linkTitle: "statestores" +description: "Detailed reference documentation for applications.dapr/statestores@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [DaprStateStoreProperties](#daprstatestoreproperties) | Dapr StateStore portable resource properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Dapr/stateStores' | The resource type
_(read-only, deploy-time constant)_ | + +### DaprStateStoreProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(read-only)_ | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **metadata** | any | Any object | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the state store | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | +| **version** | string | Dapr component version | + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | Resource id of an existing resource
_(required)_ | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + diff --git a/docs/content/reference/resources/applications/applications.dapr/_index.md b/docs/content/reference/resources/applications/applications.dapr/_index.md new file mode 100644 index 000000000..113521f71 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.dapr/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: applications.dapr" +linkTitle: "applications.dapr" +description: "Detailed reference documentation for applications.dapr" +--- + diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/_index.md new file mode 100644 index 000000000..af94c70a6 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: 2023-10-01-preview" +linkTitle: "2023-10-01-preview" +description: "Detailed reference documentation for 2023-10-01-preview" +--- + diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md new file mode 100644 index 000000000..c572a47f0 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md @@ -0,0 +1,171 @@ +--- +type: docs +title: "Reference: applications.datastores/mongodatabases@2023-10-01-preview" +linkTitle: "mongodatabases" +description: "Detailed reference documentation for applications.datastores/mongodatabases@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [MongoDatabaseProperties](#mongodatabaseproperties) | MongoDatabase portable resource properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Datastores/mongoDatabases' | The resource type
_(read-only, deploy-time constant)_ | + +### Function listSecrets (Applications.Datastores/mongoDatabases@2023-10-01-preview) + +* **Resource**: Applications.Datastores/mongoDatabases +* **ApiVersion**: 2023-10-01-preview +* **Input**: any +* **Output**: [MongoDatabaseListSecretsResult](#mongodatabaselistsecretsresult) + +### MongoDatabaseProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **database** | string | Database name of the target Mongo database | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **host** | string | Host name of the target Mongo database | +| **port** | int | Port value of the target Mongo database | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource | +| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | The secret values for the given MongoDatabase resource | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **username** | string | Username to use when connecting to the target Mongo database | + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | Resource id of an existing resource
_(required)_ | + +### MongoDatabaseSecrets + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **connectionString** | string | Connection string used to connect to the target Mongo database | +| **password** | string | Password to use when connecting to the target Mongo database | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### MongoDatabaseListSecretsResult + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **connectionString** | string | Connection string used to connect to the target Mongo database
_(read-only)_ | +| **password** | string | Password to use when connecting to the target Mongo database
_(read-only)_ | + diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md new file mode 100644 index 000000000..586264f65 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md @@ -0,0 +1,173 @@ +--- +type: docs +title: "Reference: applications.datastores/rediscaches@2023-10-01-preview" +linkTitle: "rediscaches" +description: "Detailed reference documentation for applications.datastores/rediscaches@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [RedisCacheProperties](#rediscacheproperties) | RedisCache portable resource properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Datastores/redisCaches' | The resource type
_(read-only, deploy-time constant)_ | + +### Function listSecrets (Applications.Datastores/redisCaches@2023-10-01-preview) + +* **Resource**: Applications.Datastores/redisCaches +* **ApiVersion**: 2023-10-01-preview +* **Input**: any +* **Output**: [RedisCacheListSecretsResult](#rediscachelistsecretsresult) + +### RedisCacheProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **host** | string | The host name of the target Redis cache | +| **port** | int | The port value of the target Redis cache | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource | +| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | The secret values for the given RedisCache resource | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **tls** | bool | Specifies whether to enable SSL connections to the Redis cache | +| **username** | string | The username for Redis cache | + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | Resource id of an existing resource
_(required)_ | + +### RedisCacheSecrets + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **connectionString** | string | The connection string used to connect to the Redis cache | +| **password** | string | The password for this Redis cache instance | +| **url** | string | The URL used to connect to the Redis cache | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### RedisCacheListSecretsResult + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **connectionString** | string | The connection string used to connect to the Redis cache
_(read-only)_ | +| **password** | string | The password for this Redis cache instance
_(read-only)_ | +| **url** | string | The URL used to connect to the Redis cache
_(read-only)_ | + diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md new file mode 100644 index 000000000..818dba95b --- /dev/null +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md @@ -0,0 +1,171 @@ +--- +type: docs +title: "Reference: applications.datastores/sqldatabases@2023-10-01-preview" +linkTitle: "sqldatabases" +description: "Detailed reference documentation for applications.datastores/sqldatabases@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [SqlDatabaseProperties](#sqldatabaseproperties) | SqlDatabase properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Datastores/sqlDatabases' | The resource type
_(read-only, deploy-time constant)_ | + +### Function listSecrets (Applications.Datastores/sqlDatabases@2023-10-01-preview) + +* **Resource**: Applications.Datastores/sqlDatabases +* **ApiVersion**: 2023-10-01-preview +* **Input**: any +* **Output**: [SqlDatabaseListSecretsResult](#sqldatabaselistsecretsresult) + +### SqlDatabaseProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **database** | string | The name of the Sql database. | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **port** | int | Port value of the target Sql database | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource | +| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | The secret values for the given SqlDatabase resource | +| **server** | string | The fully qualified domain name of the Sql database. | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **username** | string | Username to use when connecting to the target Sql database | + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | Resource id of an existing resource
_(required)_ | + +### SqlDatabaseSecrets + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **connectionString** | string | Connection string used to connect to the target Sql database | +| **password** | string | Password to use when connecting to the target Sql database | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### SqlDatabaseListSecretsResult + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **connectionString** | string | Connection string used to connect to the target Sql database
_(read-only)_ | +| **password** | string | Password to use when connecting to the target Sql database
_(read-only)_ | + diff --git a/docs/content/reference/resources/applications/applications.datastores/_index.md b/docs/content/reference/resources/applications/applications.datastores/_index.md new file mode 100644 index 000000000..f4d89c7c2 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.datastores/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: applications.datastores" +linkTitle: "applications.datastores" +description: "Detailed reference documentation for applications.datastores" +--- + diff --git a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/_index.md b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/_index.md new file mode 100644 index 000000000..af94c70a6 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: 2023-10-01-preview" +linkTitle: "2023-10-01-preview" +description: "Detailed reference documentation for 2023-10-01-preview" +--- + diff --git a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md new file mode 100644 index 000000000..b90136312 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md @@ -0,0 +1,173 @@ +--- +type: docs +title: "Reference: applications.messaging/rabbitmqqueues@2023-10-01-preview" +linkTitle: "rabbitmqqueues" +description: "Detailed reference documentation for applications.messaging/rabbitmqqueues@2023-10-01-preview" +--- + +{{< schemaExample >}} + +## Schema + +### Top-Level Resource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | +| **id** | string | The resource id
_(read-only, deploy-time constant)_ | +| **location** | string | The geo-location where the resource lives
_(required)_ | +| **name** | string | The resource name
_(required, deploy-time constant)_ | +| **properties** | [RabbitMQQueueProperties](#rabbitmqqueueproperties) | RabbitMQQueue portable resource properties | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **type** | 'Applications.Messaging/rabbitMQQueues' | The resource type
_(read-only, deploy-time constant)_ | + +### Function listSecrets (Applications.Messaging/rabbitMQQueues@2023-10-01-preview) + +* **Resource**: Applications.Messaging/rabbitMQQueues +* **ApiVersion**: 2023-10-01-preview +* **Input**: any +* **Output**: [RabbitMQListSecretsResult](#rabbitmqlistsecretsresult) + +### RabbitMQQueueProperties + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **host** | string | The hostname of the RabbitMQ instance | +| **port** | int | The port of the RabbitMQ instance. Defaults to 5672 | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **queue** | string | The name of the queue | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource | +| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The connection secrets properties to the RabbitMQ instance | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **tls** | bool | Specifies whether to use SSL when connecting to the RabbitMQ instance | +| **username** | string | The username to use when connecting to the RabbitMQ instance | +| **vHost** | string | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost. | + +### Recipe + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **parameters** | any | Any object | + +### ResourceReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | Resource id of an existing resource
_(required)_ | + +### RabbitMQSecrets + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **password** | string | The password used to connect to the RabbitMQ instance | +| **uri** | string | The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost. Can be overridden with a custom value | + +### ResourceStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | + +### EnvironmentCompute + +* **Discriminator**: kind + +#### Base Properties + +| Property | Type | Description | +|----------|------|-------------| +| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **resourceId** | string | The resource id of the compute resource for application environment. | + +#### KubernetesCompute + +##### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | +| **namespace** | string | The namespace to use for the environment.
_(required)_ | + + +### IdentitySettings + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | +| **resource** | string | The resource ID of the provisioned identity | + +### OutputResource + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **id** | string | The UCP resource ID of the underlying resource. | +| **localId** | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. | +| **radiusManaged** | bool | Determines whether Radius manages the lifecycle of the underlying resource. | + +### RecipeStatus + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | +| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateVersion** | string | TemplateVersion is the version number of the template. | + +### SystemData + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **createdAt** | string | The timestamp of resource creation (UTC). | +| **createdBy** | string | The identity that created the resource. | +| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | +| **lastModifiedBy** | string | The identity that last modified the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | + +### TrackedResourceTags + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### RabbitMQListSecretsResult + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **password** | string | The password used to connect to the RabbitMQ instance
_(read-only)_ | +| **uri** | string | The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost. Can be overridden with a custom value
_(read-only)_ | + diff --git a/docs/content/reference/resources/applications/applications.messaging/_index.md b/docs/content/reference/resources/applications/applications.messaging/_index.md new file mode 100644 index 000000000..913461173 --- /dev/null +++ b/docs/content/reference/resources/applications/applications.messaging/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Reference: applications.messaging" +linkTitle: "applications.messaging" +description: "Detailed reference documentation for applications.messaging" +--- + diff --git a/docs/content/tutorials/helm/demo-screenshot.png b/docs/content/tutorials/helm/demo-screenshot.png new file mode 100644 index 000000000..0d9f25d79 Binary files /dev/null and b/docs/content/tutorials/helm/demo-screenshot.png differ diff --git a/docs/content/tutorials/helm/demo-with-redis-screenshot.png b/docs/content/tutorials/helm/demo-with-redis-screenshot.png new file mode 100644 index 000000000..77caa8eac Binary files /dev/null and b/docs/content/tutorials/helm/demo-with-redis-screenshot.png differ diff --git a/docs/content/tutorials/helm/demo-with-todolist.png b/docs/content/tutorials/helm/demo-with-todolist.png new file mode 100644 index 000000000..6bab2cb7d Binary files /dev/null and b/docs/content/tutorials/helm/demo-with-todolist.png differ diff --git a/docs/content/tutorials/helm/diagram.png b/docs/content/tutorials/helm/diagram.png new file mode 100644 index 000000000..8c65eb5ef Binary files /dev/null and b/docs/content/tutorials/helm/diagram.png differ diff --git a/docs/content/tutorials/helm/index.md b/docs/content/tutorials/helm/index.md new file mode 100644 index 000000000..33343bc59 --- /dev/null +++ b/docs/content/tutorials/helm/index.md @@ -0,0 +1,641 @@ +--- +type: docs +title: "Tutorial: Use Helm to run your first app" +linkTitle: "Run app using Helm" +weight: 200 +description: "Take a tour of Radius by updating an existing Helm chart to add Radius support." +categories: "Tutorial" +tags : ["kubernetes", "helm"] +--- + +This tutorial will teach you the following about Radius: + +* How to use update a Helm chart to include its resources in a Radius application +* How to use features like Recipes and Connections within Kubernetes YAML or Helm + +Diagram of the application and its resources + +## Prerequisites + +- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) +- [Helm](https://helm.sh/docs/intro/install/) +- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) + +## Step 1. Clone and open the sample code + +{{< tabs "Codespace" "Local machine" >}} + +{{% codetab %}} + +It's easy and free to get up and running with a Radius Codespace in GitHub. Spin up a Radius environment in seconds with the following link: + +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/radius-project/samples) + +Once launched you should already have the application cloned locally. Use the terminal to navigate to the `./demo/` directory: + +```bash +cd ./samples/demo +``` +{{% /codetab %}} + +{{% codetab %}} +Use the terminal to clone the `samples` repository locally and navigate to the `./samples/demo` directory: + +```bash +git clone https://github.com/radius-project/samples.git +cd ./samples/samples/demo +``` +{{% /codetab %}} + +{{< /tabs >}} + + +## Step 2. Initialize Radius + +Initialize Radius. For this example, answer **NO** when asked whether to set up an application: + +> Select 'No' when prompted to create an application. + +```bash +rad init +``` + +## Step 3. Understand and deploy the application + +1. Navigate to the `./Chart` folder and browse its contents. This contains a Helm chart for the application that you will modify. + + Here are the contents of `./demo/Chart/templates/app.yaml`. This file is part of the Helm chart, and describes the container used for this tutorial: + + ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + spec: + selector: + matchLabels: + app: webapp + template: + metadata: + labels: + app: webapp + spec: + containers: + - name: webapp + image: {{ .Values.image.repository }}:{{ .Values.image.tag }} + env: + - name: CONNECTION_REDIS_URL + valueFrom: + secretKeyRef: + name: redis-secret + key: url + ports: + - containerPort: 3000 + ``` + + The container that you will be working with is a ToDo application that uses Redis as a database. + + - The container is configured to listen on port 3000. + - The container will use the environment variable `CONNECTION_REDIS_URL` to connect to Redis. + - This `CONNECTION_REDIS_URL` environment variable is populated by a Kubernetes Secret. + + You can deploy this application for the first time by following these steps: + + - Create the Kubernetes namespace `demo` + - Create the Kubernetes Secret `redis-secret` containing the Redis URL. + - Install the Helm chart. + + {{< alert title="๐Ÿ’ก Redis" color="info" >}} For now you're not going to actually deploy Redis and the URL in this step is fake. You will deploy Redis using a Recipe later in the tutorial that will replace the fake URL contained within `redis-secret` with an actual container and URL.{{< /alert >}} + +2. Complete these steps by running the following commands: + + ```bash + kubectl create namespace demo + kubectl create secret generic --namespace demo --from-literal=url=redis://fake-server redis-secret + helm upgrade demo ./Chart -n demo --install + ``` + + The output should look similar to the following: + + ``` + > kubectl create namespace demo + namespace/demo created + + > kubectl create secret generic --namespace demo --from-literal=url=redis://fake-server redis-secret + secret/redis-secret created + + > helm upgrade demo ./Chart -n demo --install + Release "demo" does not exist. Installing it now. + NAME: demo + LAST DEPLOYED: Wed Sep 13 01:05:19 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 1 + TEST SUITE: None + ``` + + {{< alert title="โš ๏ธ Chart Directory" color="warning" >}} If you see an error message like **Error: path "./Chart" not found** then you are in the wrong directory. Make sure your terminal is in the `./demo` directory of the `samples` repository.{{< /alert >}} + +3. Run the following command to check if everything is running: + + ```bash + kubectl get all -n demo + ``` + + The output should look similar to the following: + + ``` + > kubectl get all -n demo + NAME READY STATUS RESTARTS AGE + pod/webapp-79d5dfb99-vhj9g 1/1 Running 0 2m48s + + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/webapp 1/1 1 1 2m49s + + NAME DESIRED CURRENT READY AGE + replicaset.apps/webapp-79d5dfb99 1 1 1 2m49s + ``` + + > The generated names and ages of the objects will be different in your output. Make sure you see the status of `Running` for the `pod/webapp-...` entry. If the status is not `Running`, try repeating the `kubectl get all -n demo` after waiting. + + At this point you've deployed the application but you have not actually used Radius yet. You will start doing that in the next step, as well as set up and use Redis. + +The steps so far are similar to how many applications are managed today: + +- Dependencies like Redis are provisioned manually and separately from application deployment. +- Connection information like passwords and addresses is manually stored in secret stores. +- Applications access the connection information from those secret stores when they are deployed. + +Over the next few steps you will update this application to use Radius so that: + +- โœ… Dependencies like Redis are provisioned on-demand when they are needed. +- โœ… Connection information is managed automatically, secret stores are an implementation detail. +- โœ… Applications have a documented relationship with the dependencies they connect to. + +From here you will go through a series of steps to incrementally add more Radius features to the application. + +## Step 4. Add Radius + +1. Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. You will make some edits to this file to enable Radius. + + Add the `annotations` property to `metadata`, and then add the `radapp.io/enabled: 'true'` annotation. The `'true'` must be surrounded in quotes. + + The example below shows the updated `metadata` section after making the changes. + + ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + # Add the following two lines + annotations: + radapp.io/enabled: 'true' + spec: + ... + ``` + + Adding the `radapp.io/enabled: 'true'` annotation enables Radius for the deployment. + +2. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, we only need to run the `helm` command. + + ```bash + helm upgrade demo ./Chart -n demo --install + ``` + + The output should look like: + + ``` + > helm upgrade demo ./Chart -n demo --install + Release "demo" has been upgraded. Happy Helming! + NAME: demo + LAST DEPLOYED: Wed Sep 13 01:31:58 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 2 + TEST SUITE: None + ``` + + You should confirm that your output contains `REVISION: 2`, that means that the changes were applied. + +3. Run the following command to confirm that everything is running: + + ```bash + kubectl get all -n demo + ``` + + The output should look similar to the following: + + ``` + > kubectl get all -n demo + NAME READY STATUS RESTARTS AGE + pod/webapp-79d5dfb99-mv6q9 1/1 Running 0 10m + + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/webapp 1/1 1 1 10m + + NAME DESIRED CURRENT READY AGE + replicaset.apps/webapp-79d5dfb99 1 1 1 10m + ``` + + Notice that the `AGE` of `pod/webapp-...` reflects the time of your **first** deployment. Enabling Radius for an application does not change any of its behaviors, so Kubernetes did not need to restart the container. + +4. Now that Radius has been enabled, run this command to display the state of the Radius application: + + ```bash + rad app graph -a demo -g default-demo + ``` + + The output should look like this: + + ``` + > rad app graph -a demo -g default-demo + Displaying application: demo + + Name: webapp (Applications.Core/containers) + Connections: (none) + Resources: + webapp (kubernetes: apps/Deployment) + ``` + + This means that Radius has found the Kubernetes `Deployment` running your container and cataloged it as part of the application. + + {{< alert title="๐Ÿ’ก Application Name" color="info" >}}Radius will use the Kubernetes namespace as the application name by default. {{< /alert >}} + +## Step 5. Add Recipe + +This step will add a database (Redis Cache) to the application. + +You can create a Redis Cache using [Recipes]({{< ref "guides/recipes/overview" >}}) provided by Radius. The Radius community provides [Recipes](https://github.com/radius-project/recipes) for running commonly used application dependencies, including Redis. + +In this step you will: + +- Add Redis to the application using a Recipe. +- Update the Kubernetes secret with the connection information from Redis. + +1. First, check recipes installed in your environment by running: + + ```bash + rad recipe list + ``` + + You will see output like this: + + ``` + NAME TYPE TEMPLATE KIND TEMPLATE VERSION TEMPLATE + default Applications.Datastores/sqlDatabases bicep radius.ghcr.io/recipes/local-dev/sqldatabases:latest + default Applications.Messaging/rabbitMQQueues bicep radius.ghcr.io/recipes/local-dev/rabbitmqqueues:latest + default Applications.Dapr/pubSubBrokers bicep radius.ghcr.io/recipes/local-dev/pubsubbrokers:latest + default Applications.Dapr/secretStores bicep radius.ghcr.io/recipes/local-dev/secretstores:latest + default Applications.Dapr/stateStores bicep radius.ghcr.io/recipes/local-dev/statestores:latest + default Applications.Datastores/mongoDatabases bicep radius.ghcr.io/recipes/local-dev/mongodatabases:latest + default Applications.Datastores/redisCaches bicep radius.ghcr.io/recipes/local-dev/rediscaches:latest + ``` + + The recipe for `Applications.Datastores/redisCaches` is what you will use in this example. + + {{< alert title="๐Ÿ’ก Recipes" color="info" >}} + Radius includes Recipes for local development when you use `rad init`. These [**local-dev**](https://github.com/radius-project/recipes/tree/main/local-dev) Recipes run popular OSS technologies as containerized infrastructure without requiring a cloud account. + + In a production environment you can substitute recipes that will create cloud or on-premises dependencies instead. + {{< /alert >}} + +2. Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. At the bottom of the file add the following text, including the `---`: + + ```yaml + --- + apiVersion: radapp.io/v1alpha3 + kind: Recipe + metadata: + name: db + namespace: {{ .Release.Namespace }} + spec: + type: Applications.Datastores/redisCaches + secretName: redis-secret + ``` + + Defining a `Recipe` object in Kubernetes will use a Radius Recipe to create dependencies for your application: + + - The `.spec.type` field defines the type of resource to create. `Applications.Datastores/redisCaches` is the type for a Redis Cache. + - The `.spec.secretName` field tells Radius where to store connection information. This is optional, and should be used to interoperate with other Kubernetes technologies that read from secrets. This tutorial example uses the secret to populate an environment variable. + +3. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, you only need to run the `helm` command. + + ```bash + helm upgrade demo ./Chart -n demo --install + ``` + + The output should look like: + + ``` + > helm upgrade demo ./Chart -n demo --install + Release "demo" has been upgraded. Happy Helming! + NAME: demo + LAST DEPLOYED: Wed Sep 13 01:44:04 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 3 + TEST SUITE: None + ``` + + This time you should see `REVISION: 3`. + +4. Now that you are using a Recipe, you should see more resources running in Kubernetes. Run the following command: + + ```bash + kubectl get all -n demo + ``` + + The output should look similar to the following: + + ``` + > kubectl get all -n demo + + pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 51s + pod/webapp-79d5dfb99-f6xgj 1/1 Running 0 52s + + NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE + service/redis-r5tcrra3d7uh6 ClusterIP 10.43.104.63 6379/TCP 51s + + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/redis-r5tcrra3d7uh6 1/1 1 1 51s + deployment.apps/webapp 1/1 1 1 52s + + NAME DESIRED CURRENT READY AGE + replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d 1 1 1 51s + replicaset.apps/webapp-79d5dfb99 1 1 1 52s + + NAME TYPE SECRET STATUS + recipe.radapp.io/db Applications.Datastores/redisCaches redis-secret Ready + ``` + + Look at the status of the `recipe.radapp.io/db` resource. If the status is not `Ready`, then try running the command again after a delay. The status should show as `Ready` when the Recipe has fully-deployed. You can also see additional resources starting with `redis-`. These were created by the Recipe. + + {{< alert title="โš ๏ธ Missing resources" color="warning" >}} If you do not see the additional resources starting with `redis-` then it's likely they are in a different Kubernetes namespace. Run `kubectl get all -A` to see everything.{{< /alert >}} + +5. Now that you have added a Recipe, run this command to display the state of the Radius application: + + ```bash + rad app graph -a demo -g default-demo + ``` + + The output should look like this: + + ``` + > rad app graph -a demo -g default-demo + Displaying application: demo + + Name: webapp (Applications.Core/containers) + Connections: (none) + Resources: + webapp (kubernetes: apps/Deployment) + + Name: db (Applications.Datastores/redisCaches) + Connections: (none) + Resources: + redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) + redis-r5tcrra3d7uh6 (kubernetes: core/Service) + ``` + + `rad app graph` shows the **Application Graph** of the application. This includes: + + - Entries for each major resource: `webapp` is an `Applications.Core/containers` and `db` is an `Applications.Datastores/redisCaches`. + - Connections between resources: (none yet, you will add this next). + - Resources that were created: see the Kubernetes `Deployment` listed for `webapp` and the Kubernetes `Deployment` and `Service` listed for `db`. + + The Redis Cache created by the recipe is visible as part of the application. You can also see the `Resources` created in Kubernetes that make up the Redis Cache. In a previous step you saw these listed by `kubectl`. Since Radius deployed the Recipe, it knows that these resources *logically* are part of the Redis Cache in the application. + +6. You can also see the contents of `redis-secret` as created by Radius. Run the following command: + + ```bash + kubectl get secret -n demo redis-secret -o yaml + ``` + + The output should look like the following: + + ``` + >kubectl get secret -n demo redis-secret -o yaml + apiVersion: v1 + data: + connectionString: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2FsOjYzNzksYWJvcnRDb25uZWN0PUZhbHNl + host: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2Fs + password: "" + port: NjM3OQ== + tls: ZmFsc2U= + url: cmVkaXM6Ly9yZWRpcy1yNXRjcnJhM2Q3dWg2LmRlbW8uc3ZjLmNsdXN0ZXIubG9jYWw6NjM3OS8wPw== + username: "" + kind: Secret + metadata: + creationTimestamp: "2023-09-13T01:49:36Z" + name: redis-secret + namespace: demo + ownerReferences: + - apiVersion: radapp.io/v1alpha3 + blockOwnerDeletion: true + controller: true + kind: Recipe + name: db + uid: d40567a1-cd52-4984-8321-6cb8bea5f798 + resourceVersion: "3672" + uid: b1613fb0-09e6-4f76-8685-02f458e173b9 + type: Opaque + ``` + + The actual values like `connectionString` are Base64 encoded in this display. The `url` value in this secret is being used by the container to connect to the Redis Cache. For each type of Recipe, Radius stores the most-commonly used connection information for the convenience of application developers. + +## Step 6. Add Connection + +At this point you have added Radius to your existing container and used a Recipe to create a Redis Cache. In this step, you will use Radius Connections to inject settings into the container instead of explicitly managing a secret. + +Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. + +1. First, add another annotation. This time add the `radapp.io/connection-redis: 'db'` annotation, to `.metadata.annotations`. Order does not matter but indentation does. + + Here's the updated content of `metadata`: + + ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + annotations: + radapp.io/enabled: 'true' + radapp.io/connection-redis: 'db' + spec: + ... + ``` + + The `radapp.io/connection-` annotation defines a connection from the container to some other dependency. Each connection has: + + - A name: `redis` is the connection name this case. + - A source: `db` is the name of the Recipe you created earlier. + + Connections are named because you can define many of them. The connection name is used to generate environment variables that are unique to the connection. + + Since you're using a connection called `redis`, Radius will automatically define the `CONNECTION_REDIS_URL` environment variable. The prefix of `CONNECTION_REDIS_` will be combined with each of the settings that you could see in the `redis-secret` secret in the previous step. + +2. You can remove the manual definition of `CONNECTION_REDIS_URL` from `app.yaml` since Radius will provide it automatically. Find the `env` property and delete all of its contents. You can also remove `.spec.secretName` from the `Recipe`. + + The final contents of `app.yaml` should look like: + + ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + annotations: + radapp.io/enabled: 'true' + radapp.io/connection-redis: 'db' + spec: + selector: + matchLabels: + app: webapp + template: + metadata: + labels: + app: webapp + spec: + containers: + - name: webapp + image: {{ .Values.image.repository }}:{{ .Values.image.tag }} + ports: + - containerPort: 3000 + --- + apiVersion: radapp.io/v1alpha3 + kind: Recipe + metadata: + name: db + namespace: {{ .Release.Namespace }} + spec: + type: Applications.Datastores/redisCaches + ``` + +3. Save the file after you have made the edits and deploy the application again using Helm. + + ```bash + helm upgrade demo ./Chart -n demo --install + ``` + + The output should look like: + + ``` + > helm upgrade demo ./Chart -n demo --install + Release "demo" has been upgraded. Happy Helming! + NAME: demo + LAST DEPLOYED: Wed Sep 13 02:09:41 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 4 + TEST SUITE: None + ``` + + This time you should see `REVISION: 4`. + + Check the status in Kubernetes again by running: + + ```bash + kubectl get all -n demo + ``` + + The output should look like: + + ``` + > kubectl get all -n demo + NAME READY STATUS RESTARTS AGE + pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 20m + pod/webapp-76db7964d8-plc2s 1/1 Running 0 37s + + NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE + service/redis-r5tcrra3d7uh6 ClusterIP 10.43.104.63 6379/TCP 20m + + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/redis-r5tcrra3d7uh6 1/1 1 1 20m + deployment.apps/webapp 1/1 1 1 20m + + NAME DESIRED CURRENT READY AGE + replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d 1 1 1 20m + replicaset.apps/webapp-79d5dfb99 0 0 0 20m + replicaset.apps/webapp-76db7964d8 1 1 1 37s + replicaset.apps/webapp-687dcf5cdf 0 0 0 38s + + NAME TYPE SECRET STATUS + recipe.radapp.io/db Applications.Datastores/redisCaches Ready + ``` + + Depending on the timing you may see pods in the `Terminating` state. This is normal as old replicas take some time to shut down. + +4. Check the Radius status again. Now Radius is aware of the connection from `webapp->db`: + + ```bash + rad app graph -a demo -g default-demo + ``` + + The output should look like the example below: + + ``` + > rad app graph -a demo -g default-demo + Displaying application: demo + + Name: webapp (Applications.Core/containers) + Connections: + webapp -> db (Applications.Datastores/redisCaches) + Resources: + webapp (kubernetes: apps/Deployment) + + Name: db (Applications.Datastores/redisCaches) + Connections: + webapp (Applications.Core/containers) -> db + Resources: + redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) + redis-r5tcrra3d7uh6 (kubernetes: core/Service) + ``` + +## Step 7. Try it out + +In this step you can access the application and explore its features. Since the container is running inside Kubernetes, you need to run a port-forward to use it locally. + +1. Run the following command to start the port-forward: + + ```bash + kubectl port-forward -n demo deployment/webapp 3000 + ``` + + If you are inside Codespaces this will open a new browser tab that you can use to access the webapp. + + If you are not using Codespaces then open your browser and navigate to `http://localhost:3000` + + Screenshot of the demo container +

+ + Congrats! You're running your first Radius app. + + You can use the homepage to view information about the container and its settings. + +2. Navigate to the ToDo List tab and test out the application. Using the ToDo page will update the saved state in Redis. + + Screenshot of the todolist +

+ + When you're ready to move on to the next step, use `CTRL+C` to exit the command. + +## Cleanup and next steps + +To delete your app, run the following command: + +> This command also cleans up all the resources created by the Radius Recipe you deployed earlier. + +```bash +helm uninstall demo -n demo +``` + +In summary, this tutorial walked through a hands-on example to show you how-to: + +- Enable Radius for a Helm or Kubernetes-based application to catalog your assets. +- Use Recipes to create dependencies either for development or production use. +- Use Connections to automate the management of connection information. + +
+{{< button text="Next step: Try another tutorial" page="tutorials" >}} diff --git a/docs/content/tutorials/new-app/index.md b/docs/content/tutorials/new-app/index.md index 4d08874d5..7cadf5464 100644 --- a/docs/content/tutorials/new-app/index.md +++ b/docs/content/tutorials/new-app/index.md @@ -252,13 +252,13 @@ In addition to containers, you can add dependencies like Redis caches, Dapr Stat Resources: myapp Applications.Core/applications - frontend Applications.Core/containers + demo Applications.Core/containers mongodb Applications.Datastores/mongoDatabases Starting log stream... ``` -1. Open [localhost:3000](http://localhost:3000) to interact with the frontend container. You should see the container's connections and metadata, this time with a connection to the Mongo database and new environment variables set: +1. Open [localhost:3000](http://localhost:3000) to interact with the demo container. You should see the container's connections and metadata, this time with a connection to the Mongo database and new environment variables set: {{< image src="demo-landing-connection.png" alt="Screenshot of the Radius demo container" width=500px >}} @@ -275,20 +275,20 @@ In addition to containers, you can add dependencies like Redis caches, Dapr Stat ``` Displaying application: myapp - Name: frontend (Applications.Core/containers) + Name: demo (Applications.Core/containers) Connections: - frontend -> mongodb (Applications.Datastores/mongoDatabases) + demo -> mongodb (Applications.Datastores/mongoDatabases) Resources: - frontend (kubernetes: apps/Deployment) - frontend (kubernetes: core/Secret) - frontend (kubernetes: core/Service) - frontend (kubernetes: core/ServiceAccount) - frontend (kubernetes: rbac.authorization.k8s.io/Role) - frontend (kubernetes: rbac.authorization.k8s.io/RoleBinding) + demo (kubernetes: apps/Deployment) + demo (kubernetes: core/Secret) + demo (kubernetes: core/Service) + demo (kubernetes: core/ServiceAccount) + demo (kubernetes: rbac.authorization.k8s.io/Role) + demo (kubernetes: rbac.authorization.k8s.io/RoleBinding) Name: mongodb (Applications.Datastores/mongoDatabases) Connections: - frontend (Applications.Core/containers) -> mongodb + demo (Applications.Core/containers) -> mongodb Resources: mongo-bzmp2btdgzez6 (kubernetes: apps/Deployment) mongo-bzmp2btdgzez6 (kubernetes: core/Service) @@ -302,7 +302,7 @@ In addition to dependencies, you can add more containers to make your applicatio {{% rad file="snippets/3-app-backend.bicep" embed=true marker="//BACKEND" %}} -1. Add a new connection from your `frontend` container to the `backend` container: +1. Add a new connection from your `demo` container to the `backend` container: {{% rad file="snippets/3-app-backend.bicep" embed=true marker="//CONTAINER" markdownConfig="{hl_lines=[\"20-22\"]}" %}} @@ -322,14 +322,14 @@ In addition to dependencies, you can add more containers to make your applicatio Deployment Complete Resources: - frontend Applications.Core/containers + demo Applications.Core/containers backend Applications.Core/containers mongodb Applications.Datastores/mongoDatabases Starting log stream... ``` -1. Open [localhost:3000](http://localhost:3000) to interact with the frontend container. You should see the container's connections and metadata, this time with a connection to the backend container and new environment variables set: +1. Open [localhost:3000](http://localhost:3000) to interact with the demo container. You should see the container's connections and metadata, this time with a connection to the backend container and new environment variables set: {{< image src="demo-landing-backend.png" alt="Screenshot of the demo container with a connection to the backend container" width=600px >}} @@ -359,7 +359,7 @@ Finally, you can add a gateway to your application. Gateways are used to expose Deployment Complete Resources: - frontend Applications.Core/containers + demo Applications.Core/containers backend Applications.Core/containers gateway Applications.Core/gateways mongodb Applications.Datastores/mongoDatabases diff --git a/docs/content/tutorials/new-app/snippets/3-app-backend.bicep b/docs/content/tutorials/new-app/snippets/3-app-backend.bicep index 9f4e76db7..e3ad8d405 100644 --- a/docs/content/tutorials/new-app/snippets/3-app-backend.bicep +++ b/docs/content/tutorials/new-app/snippets/3-app-backend.bicep @@ -8,8 +8,8 @@ param application string param environment string //CONTAINER -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' +resource demo 'Applications.Core/containers@2023-10-01-preview' = { + name: 'demo' properties: { application: application container: { @@ -28,7 +28,7 @@ resource frontend 'Applications.Core/containers@2023-10-01-preview' = { source: mongodb.id } backend: { - source: 'http://backend:3000' + source: 'http://backend:80' } } } diff --git a/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep b/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep index e551086b6..0d075265a 100644 --- a/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep +++ b/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep @@ -8,8 +8,8 @@ param application string param environment string //CONTAINER -resource frontend 'Applications.Core/containers@2023-10-01-preview' = { - name: 'frontend' +resource demo 'Applications.Core/containers@2023-10-01-preview' = { + name: 'demo' properties: { application: application container: { @@ -70,7 +70,7 @@ resource gateway 'Applications.Core/gateways@2023-10-01-preview' = { routes: [ { path: '/' - destination: 'http://frontend:3000' + destination: 'http://demo:3000' } ] } diff --git a/docs/content/tutorials/tutorial-dapr/index.md b/docs/content/tutorials/tutorial-dapr/index.md index de6f08801..7b82b66bb 100644 --- a/docs/content/tutorials/tutorial-dapr/index.md +++ b/docs/content/tutorials/tutorial-dapr/index.md @@ -14,22 +14,40 @@ This tutorial will teach you the following about Dapr: - How to use Radius to deploy a Dapr microservices sample application for an online shop - How [Dapr and Radius]({{< ref "guides/author-apps/dapr" >}}) seamlessly work together -For more details on the app and access to the source code, visit the `tutorials/dapr` directory in the [samples repo](https://github.com/radius-project/samples). _For access to the radius-project GitHub org, please complete and submit [this form](https://aka.ms/ProjectRadius/GitHubAccess)._ +For more details on the app and access to the source code, visit the `tutorials/dapr` directory in the [samples repo](https://github.com/radius-project/samples). ## Prerequisites - [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) - [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) +- [Setup a supported Kubernetes cluster](https://docs.radapp.io/guides/operations/kubernetes/overview/#supported-clusters) - [Dapr installed on your Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/) -## Step 1: Define the application, `backend` container, and Dapr state store +## Step 1: Initialize a Radius Environment + +1. Begin in a new directory for your application: + + ```bash + mkdir dapr + cd dapr + ``` + +2. Initialize a new dev environment: + + *Select 'Yes' when prompted to create an application.* + + ```bash + rad init + ``` + +## Step 2: Define the application, `backend` container, and Dapr state store Begin by creating a new file named `dapr.bicep` with a Radius Application that consists of a `backend` container and Dapr state store with Redis: {{< rad file="snippets/dapr.bicep" embed=true marker="//BACKEND" >}} -## Step 2: Deploy the `backend` application +## Step 3: Deploy the `backend` application 1. Deploy the application's `backend` container and Dapr state store: @@ -68,13 +86,13 @@ Begin by creating a new file named `dapr.bicep` with a Radius Application that c default-dapr statestore state.redis v1 2023-07-21 16:04.27 21m ``` -## Step 3: Define the `frontend` container +## Step 4: Define the `frontend` container Add a `frontend` [container]({{< ref "guides/author-apps/containers" >}}) which will serve as the application's user interface. {{< rad file="snippets/dapr.bicep" embed=true marker="//FRONTEND" >}} -## Step 4. Deploy and run the `frontend` application +## Step 5. Deploy and run the `frontend` application 1. Use Radius to deploy and run the application with a single command: @@ -94,7 +112,7 @@ Add a `frontend` [container]({{< ref "guides/author-apps/containers" >}}) which statestore Applications.Dapr/stateStores ``` -## Step 5. Test your application +## Step 6. Test your application In your browser, navigate to the endpoint (e.g. [http://localhost:8080](http://localhost:8080)) to view and interact with your application: @@ -102,12 +120,12 @@ In your browser, navigate to the endpoint (e.g. [http://localhost:8080](http://l ## Cleanup -1. Press CTRL+C to terminate the `rad run` log console +1. Press `CTRL`+`C` to terminate the log console -1. Run `rad app delete` to cleanup your Radius Application, containers, and Dapr statestore. The Recipe resources (_Redis container and Dapr component_) are also automatically cleaned up. +1. Run the following command to cleanup your Radius Application, containers, and Dapr statestore. The Recipe resources (_Redis container and Dapr component_) are also automatically cleaned up. ```bash - rad app delete -a dapr + rad app delete ``` ## Next steps diff --git a/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep b/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep index 62bd724d2..3a0777c8b 100644 --- a/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep +++ b/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep @@ -4,18 +4,14 @@ import radius as radius @description('Specifies the environment for resources.') param environment string -resource app 'Applications.Core/applications@2023-10-01-preview' = { - name: 'dapr' - properties: { - environment: environment - } -} +@description('The ID of your Radius Application. Automatically injected by the rad CLI.') +param application string // The backend container that is connected to the Dapr state store resource backend 'Applications.Core/containers@2023-10-01-preview' = { name: 'backend' properties: { - application: app.id + application: application container: { // This image is where the app's backend code lives image: 'ghcr.io/radius-project/samples/dapr-backend:latest' @@ -46,7 +42,7 @@ resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { properties: { // Provision Redis Dapr state store automatically via the default Radius Recipe environment: environment - application: app.id + application: application } } //BACKEND @@ -56,13 +52,15 @@ resource stateStore 'Applications.Dapr/stateStores@2023-10-01-preview' = { resource frontend 'Applications.Core/containers@2023-10-01-preview' = { name: 'frontend' properties: { - application: app.id + application: application container: { // This image is where the app's frontend code lives image: 'ghcr.io/radius-project/samples/dapr-frontend:latest' env: { // An environment variable to tell the frontend container where to find the backend CONNECTION_BACKEND_APPID: 'backend' + // An environment variable to override the default port that .NET Core listens on + ASPNETCORE_URLS: 'http://*:8080' } // The frontend container exposes port 8080, which is used to serve the UI ports: { diff --git a/docs/layouts/shortcodes/schemaExample.html b/docs/layouts/shortcodes/schemaExample.html new file mode 100644 index 000000000..1a540eee4 --- /dev/null +++ b/docs/layouts/shortcodes/schemaExample.html @@ -0,0 +1,7 @@ +{{ $bicepExample := "example.bicep" }} +{{ $bicepExamplePath := path.Join .Page.File.Dir $bicepExample }} + +{{ if fileExists $bicepExamplePath }} +{{ $bicepContent := $bicepExamplePath | readFile }} +{{ highlight $bicepContent "bicep" }} +{{ end }} \ No newline at end of file diff --git a/redirect/README.md b/redirect/README.md new file mode 100644 index 000000000..0f2d8e625 --- /dev/null +++ b/redirect/README.md @@ -0,0 +1,3 @@ +# Redirect Page + +Our current domain, `radapp.io`, is the homepage for Radius. We previously operated on `radapp.dev` and may still have some remaining links to that domain. This directory contains a redirect page that we host on `radapp.dev` to redirect to `radapp.io`. diff --git a/redirect/src/index.html b/redirect/src/index.html new file mode 100644 index 000000000..2e9a35686 --- /dev/null +++ b/redirect/src/index.html @@ -0,0 +1,10 @@ + + + + Redirecting to https://radapp.io + + + +

Please wait while you are redirected to https://radapp.io

+ +