Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update auto-generated documentation #959

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1070,3 +1070,137 @@ 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
14 changes: 9 additions & 5 deletions docs/content/reference/cli/rad_install_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/content/reference/resources/applications/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Reference: applications"
linkTitle: "applications"
description: "Detailed reference documentation for applications"
---

Original file line number Diff line number Diff line change
@@ -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"
---

Original file line number Diff line number Diff line change
@@ -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 <br />_(read-only, deploy-time constant)_ |
| **id** | string | The resource id <br />_(read-only, deploy-time constant)_ |
| **location** | string | The geo-location where the resource lives <br />_(required)_ |
| **name** | string | The resource name <br />_(required, deploy-time constant)_ |
| **properties** | [ApplicationProperties](#applicationproperties) | Application properties |
| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource. <br />_(read-only)_ |
| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. |
| **type** | 'Applications.Core/applications' | The resource type <br />_(read-only, deploy-time constant)_ |

### ApplicationProperties

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(required)_ |
| **extensions** | [Extension](#extension)[] | The application extension. |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the portable resource at the time the operation was called <br />_(read-only)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(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. <br />_(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. <br />_(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. <br />_(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. <br />_(required)_ |
| **namespace** | string | The namespace of the application environment. <br />_(required)_ |

#### ManualScalingExtension

##### Properties

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'manualScaling' | Discriminator property for Extension. <br />_(required)_ |
| **replicas** | int | Replica count. <br />_(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. <br />_(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. <br />_(required)_ |
| **namespace** | string | The namespace to use for the environment. <br />_(required)_ |


### IdentitySettings

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting <br />_(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. <br />_(required)_ |
| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. <br />_(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

Loading
Loading