Skip to content

Commit

Permalink
[WIP] - CustomResourceDefinition(CRD) term changed (#3696)
Browse files Browse the repository at this point in the history
* [WIP] - CustomResourceDefinition(CRD) term changed to Resource Specifications(resource)

Signed-off-by: sakibian <sakib192@gmail.com>

* Update daprdocs/content/en/reference/resource-specs/component-schema.md

Signed-off-by: Mark Fussell <markfussell@gmail.com>

---------

Signed-off-by: sakibian <sakib192@gmail.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
  • Loading branch information
sakibian and msfussell committed Sep 12, 2023
1 parent b11004c commit e34b4f5
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
Expand Up @@ -176,7 +176,7 @@ Below are the supported parameters for VS Code tasks. These parameters are equiv
| `appProtocol` | Tells Dapr which protocol your application is using. Valid options are `http`, `grpc`, `https`, `grpcs`, `h2c`. Default is `http`. | No | `"appProtocol": "http"`
| `args` | Sets a list of arguments to pass on to the Dapr app | No | "args": []
| `componentsPath` | Path for components directory. If empty, components will not be loaded. | No | `"componentsPath": "./components"`
| `config` | Tells Dapr which Configuration CRD to use | No | `"config": "./config"`
| `config` | Tells Dapr which Configuration resource to use | No | `"config": "./config"`
| `controlPlaneAddress` | Address for a Dapr control plane | No | `"controlPlaneAddress": "http://localhost:1366/"`
| `enableProfiling` | Enable profiling | No | `"enableProfiling": false`
| `enableMtls` | Enables automatic mTLS for daprd to daprd communication channels | No | `"enableMtls": false`
Expand Down
Expand Up @@ -18,13 +18,13 @@ A Dapr sidecar can also apply a configuration by using a `--config` flag to the

#### Kubernetes sidecar

In Kubernetes mode the Dapr configuration is a Configuration CRD, that is applied to the cluster. For example:
In Kubernetes mode the Dapr configuration is a Configuration resource, that is applied to the cluster. For example:

```bash
kubectl apply -f myappconfig.yaml
```

You can use the Dapr CLI to list the Configuration CRDs
You can use the Dapr CLI to list the Configuration resources

```bash
dapr configurations -k
Expand Down
4 changes: 2 additions & 2 deletions daprdocs/content/en/operations/configuration/secret-scope.md
Expand Up @@ -3,12 +3,12 @@ type: docs
title: "How-To: Limit the secrets that can be read from secret stores"
linkTitle: "Limit secret store access"
weight: 3000
description: "To limit the secrets to which the Dapr application has access, users can define secret scopes by augmenting existing configuration CRD with restrictive permissions."
description: "To limit the secrets to which the Dapr application has access, users can define secret scopes by augmenting existing configuration resource with restrictive permissions."
---

In addition to scoping which applications can access a given component, for example a secret store component (see [Scoping components]({{< ref "component-scopes.md">}})), a named secret store component itself can be scoped to one or more secrets for an application. By defining `allowedSecrets` and/or `deniedSecrets` list, applications can be restricted to access only specific secrets.

Follow [these instructions]({{< ref "configuration-overview.md" >}}) to define a configuration CRD.
Follow [these instructions]({{< ref "configuration-overview.md" >}}) to define a configuration resource.

## Configure secrets access

Expand Down
Expand Up @@ -55,7 +55,7 @@ From version 1.0.0 onwards, upgrading Dapr using Helm is no longer a disruptive

1. Upgrade Dapr from 1.0.0 (or newer) to any [NEW VERSION] > 1.0.0:

*Helm does not handle upgrading CRDs, so you need to perform that manually. CRDs are backward-compatible and should only be installed forward.*
*Helm does not handle upgrading resources, so you need to perform that manually. resources are backward-compatible and should only be installed forward.*

>Note: The Dapr version is included in the commands below.
Expand Down
Expand Up @@ -15,7 +15,7 @@ Breaking changes are defined as a change to any of the following that cause comp
- Default configuration value
- Command line argument
- Published metric
- Kubernetes CRD template
- Kubernetes resource template
- Publicly accessible API
- Publicly visible SDK interface, method, class, or attribute

Expand Down
Expand Up @@ -94,7 +94,7 @@ There are some known cases where this might not properly work:

- Make sure the kube api server can reach the following webhooks services:
- [Sidecar Mutating Webhook Injector Service](https://github.com/dapr/dapr/blob/44235fe8e8799589bb393a3124d2564db2dd6885/charts/dapr/charts/dapr_sidecar_injector/templates/dapr_sidecar_injector_deployment.yaml#L157) at port __4000__ that is served from the sidecar injector.
- [CRD Conversion Webhook Service](https://github.com/dapr/dapr/blob/44235fe8e8799589bb393a3124d2564db2dd6885/charts/dapr/charts/dapr_operator/templates/dapr_operator_service.yaml#L28) at port __19443__ that is served from the operator.
- [Resource Conversion Webhook Service](https://github.com/dapr/dapr/blob/44235fe8e8799589bb393a3124d2564db2dd6885/charts/dapr/charts/dapr_operator/templates/dapr_operator_service.yaml#L28) at port __19443__ that is served from the operator.

Check with your cluster administrators to setup allow ingress
rules to the above ports, __4000__ and __19443__, in the cluster from the kube api servers.
Expand Down
Expand Up @@ -17,7 +17,7 @@ This table is meant to help users understand the equivalent options for running
| `--app-port` | `--app-port` | `-p` | `dapr.io/app-port` | This parameter tells Dapr which port your application is listening on |
| `--components-path` | `--components-path` | `-d` | not supported | **Deprecated** in favor of `--resources-path` |
| `--resources-path` | `--resources-path` | `-d` | not supported | Path for components directory. If empty, components will not be loaded. |
| `--config` | `--config` | `-c` | `dapr.io/config` | Tells Dapr which Configuration CRD to use |
| `--config` | `--config` | `-c` | `dapr.io/config` | Tells Dapr which Configuration resource to use |
| `--control-plane-address` | not supported | | not supported | Address for a Dapr control plane |
| `--dapr-grpc-port` | `--dapr-grpc-port` | | not supported | gRPC port for the Dapr API to listen on (default "50001") |
| `--dapr-http-port` | `--dapr-http-port` | | not supported | The HTTP port for the Dapr API |
Expand Down
Expand Up @@ -6,7 +6,7 @@ weight: 1000
description: "The basic spec for a Dapr component"
---

Dapr defines and registers components using a [CustomResourceDefinition](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/). All components are defined as a CRD and can be applied to any hosting environment where Dapr is running, not just Kubernetes.
Dapr defines and registers components using a [resource specifications](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/). All components are defined as a resource and can be applied to any hosting environment where Dapr is running, not just Kubernetes.

## Format

Expand All @@ -31,7 +31,7 @@ spec:
| Field | Required | Details | Example |
|--------------------|:--------:|---------|---------|
| apiVersion | Y | The version of the Dapr (and Kubernetes if applicable) API you are calling | `dapr.io/v1alpha1`
| kind | Y | The type of CRD. For components is must always be `Component` | `Component`
| kind | Y | The type of resource. For components is must always be `Component` | `Component`
| **metadata** | - | **Information about the component registration** |
| metadata.name | Y | The name of the component | `prod-statestore`
| metadata.namespace | N | The namespace for the component for hosting environments with namespaces | `myapp-namespace`
Expand Down

0 comments on commit e34b4f5

Please sign in to comment.