diff --git a/OLD/best-practices/security/README.md b/OLD/best-practices/security/README.md deleted file mode 100644 index 80ad73079..000000000 --- a/OLD/best-practices/security/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# documentation - -Content for this file to be added diff --git a/OLD/howto/README.md b/OLD/howto/README.md deleted file mode 100644 index 294cc5aad..000000000 --- a/OLD/howto/README.md +++ /dev/null @@ -1,110 +0,0 @@ -# How Tos - -Here you'll find a list of "How To" guides that walk you through accomplishing specific tasks. - -## Contents -- [Service invocation](#service-invocation) -- [State management](#state-management) -- [Pub/Sub](#pubsub) -- [Bindings](#bindings-and-triggers) -- [Actors](#actors) -- [Observability](#observability) -- [Security](#security) -- [Middleware](#middleware) -- [Components](#components) -- [Hosting platforms](#hosting-platforms) -- [Developer tooling](#developer-tooling) - -## Service invocation - -* [Invoke other services in your cluster or environment](./invoke-and-discover-services) -* [Create a gRPC enabled app, and invoke Dapr over gRPC](./create-grpc-app) - -## State Management - -* [Setup a state store](./setup-state-store) -* [Create a service that performs stateful CRUD operations](./create-stateful-service) -* [Query the underlying state store](./query-state-store) -* [Create a stateful, replicated service with different consistency/concurrency levels](./stateful-replicated-service) -* [Control your app's throttling using rate limiting features](./control-concurrency) -* [Configuring Redis for state management ](./configure-redis) - -## Pub/Sub - -* [Setup Dapr Pub/Sub](./setup-pub-sub-message-broker) -* [Use Pub/Sub to publish messages to a given topic](./publish-topic) -* [Use Pub/Sub to consume events from a topic](./consume-topic) -* [Use Pub/Sub across multiple namespaces](./pubsub-namespaces) -* [Configuring Redis for pub/sub](./configure-redis) -* [Limit the Pub/Sub topics used or scope them to one or more applications](./pubsub-scopes) - -## Bindings and Triggers -* [Implementing a new binding](https://github.com/dapr/docs/tree/master/reference/specs/bindings) -* [Trigger a service from different resources with input bindings](./trigger-app-with-input-binding) -* [Invoke different resources using output bindings](./send-events-with-output-bindings) - -## Actors -For Actors How Tos see the SDK documentation -* [.NET Actors](https://github.com/dapr/dotnet-sdk/blob/master/docs/get-started-dapr-actor.md) -* [Java Actors](https://github.com/dapr/java-sdk) - -## Observability - -### Metrics and Logs - -* [Set up Azure Monitor to search logs and collect metrics for Dapr](./setup-monitoring-tools/setup-azure-monitor.md) -* [Set up Fleuntd, Elastic search, and Kibana in Kubernetes](./setup-monitoring-tools/setup-fluentd-es-kibana.md) -* [Set up Prometheus and Grafana in Kubernetes](./setup-monitoring-tools/setup-prometheus-grafana.md) -* [Observe metrics with Grafana](./setup-monitoring-tools/observe-metrics-with-grafana.md) - -### Distributed Tracing - -* [Diagnose your services with distributed tracing](./diagnose-with-tracing) -* [Use W3C Trace Context](./use-w3c-tracecontext) - -## Security - -### Dapr APIs Authentication - -* [Enable Dapr APIs token-based authentication](./enable-dapr-api-token-based-authentication) - -### Mutual Transport Layer Security (mTLS) - -* [Setup and configure mutual TLS between Dapr instances](./configure-mtls) - -### Secrets - -* [Configure component secrets using Dapr secret stores](./setup-secret-store) -* [Using the Secrets API to get application secrets](./get-secrets) - -## Middleware - -* [Configure API authorization with OAuth](./authorization-with-oauth) - -## Components - -* [Limit components for one or more applications using scopes](./components-scopes) - -## Hosting Platforms -### Kubernetes Configuration - -* [Production deployment and upgrade guidelines](./deploy-k8s-prod) -* [Sidecar configuration on Kubernetes](./configure-k8s) -* [Autoscale on Kubernetes using KEDA and Dapr bindings](./autoscale-with-keda) -* [Deploy to hybrid Linux/Windows Kubernetes clusters](./windows-k8s) - -## Developer tooling -### Using Visual Studio Code - -* [Using Remote Containers for application development](./vscode-remote-containers) -* [Developing and debugging Dapr applications](./vscode-debugging-daprd) - -* [Setup development environment for Dapr runtime development ](https://github.com/dapr/dapr/blob/master/docs/development/setup-dapr-development-using-vscode.md) - -### Using IntelliJ - -* [Developing and debugging with daprd](./intellij-debugging-daprd) - -### SDKs - -* [Serialization in Dapr's SDKs](./serialize) diff --git a/OLD/howto/send-events-with-output-bindings/README.md b/daprdocs/content/en/docs/building-blocks/bindings/guide-bindings.md similarity index 95% rename from OLD/howto/send-events-with-output-bindings/README.md rename to daprdocs/content/en/docs/building-blocks/bindings/guide-bindings.md index bd5f032b0..e8496a7a8 100644 --- a/OLD/howto/send-events-with-output-bindings/README.md +++ b/daprdocs/content/en/docs/building-blocks/bindings/guide-bindings.md @@ -1,4 +1,8 @@ -# Send events to external systems using Output Bindings +--- +title: "Guide: Interface with external resource using bindings" +linkTitle: "State Management" +weight: 2000 +--- Using bindings, its possible to invoke external resources without tying in to special SDK or libraries. For a complete sample showing output bindings, visit this [link](https://github.com/dapr/quickstarts/tree/master/bindings). diff --git a/OLD/howto/trigger-app-with-input-binding/README.md b/daprdocs/content/en/docs/building-blocks/bindings/guide-triggers.md similarity index 97% rename from OLD/howto/trigger-app-with-input-binding/README.md rename to daprdocs/content/en/docs/building-blocks/bindings/guide-triggers.md index 6d36bbf6e..70250215a 100644 --- a/OLD/howto/trigger-app-with-input-binding/README.md +++ b/daprdocs/content/en/docs/building-blocks/bindings/guide-triggers.md @@ -1,4 +1,8 @@ -# Create an event-driven app using input bindings +--- +title: "Guide: Input Bindings" +linkTitle: "State Management" +weight: 1000 +--- Using bindings, your code can be triggered with incoming events from different resources which can be anything: a queue, messaging pipeline, cloud-service, filesystem etc. diff --git a/OLD/howto/publish-topic/README.md b/daprdocs/content/en/docs/building-blocks/pubsub/guide-publish-message.md similarity index 94% rename from OLD/howto/publish-topic/README.md rename to daprdocs/content/en/docs/building-blocks/pubsub/guide-publish-message.md index 03a650661..17d296af8 100644 --- a/OLD/howto/publish-topic/README.md +++ b/daprdocs/content/en/docs/building-blocks/pubsub/guide-publish-message.md @@ -1,3 +1,9 @@ +--- +title: "Guide: Publish Message to a Topic with Dapr" +linkTitle: "Guide: Publish" +weight: 4000 +--- + # Use Pub/Sub to publish a message to a topic Pub/Sub is a common pattern in a distributed system with many services that want to utilize decoupled, asynchronous messaging. diff --git a/OLD/howto/consume-topic/README.md b/daprdocs/content/en/docs/building-blocks/pubsub/guide-subscribe-topic.md similarity index 97% rename from OLD/howto/consume-topic/README.md rename to daprdocs/content/en/docs/building-blocks/pubsub/guide-subscribe-topic.md index e5f6dd5f6..8b2c9e0ba 100644 --- a/OLD/howto/consume-topic/README.md +++ b/daprdocs/content/en/docs/building-blocks/pubsub/guide-subscribe-topic.md @@ -1,4 +1,8 @@ -# Use Pub/Sub to consume messages from topics +--- +title: "Guide: Use Pub/Sub to consume messages from topics" +linkTitle: "Guide: Publish" +weight: 3000 +--- Pub/Sub is a very common pattern in a distributed system with many services that want to utilize decoupled, asynchronous messaging. Using Pub/Sub, you can enable scenarios where event consumers are decoupled from event producers. diff --git a/OLD/howto/pubsub-namespaces/README.md b/daprdocs/content/en/docs/building-blocks/pubsub/pubsub-namespaces.md similarity index 97% rename from OLD/howto/pubsub-namespaces/README.md rename to daprdocs/content/en/docs/building-blocks/pubsub/pubsub-namespaces.md index 9fa3b6229..f8be5e68c 100644 --- a/OLD/howto/pubsub-namespaces/README.md +++ b/daprdocs/content/en/docs/building-blocks/pubsub/pubsub-namespaces.md @@ -1,4 +1,8 @@ -# Using PubSub across multiple namespaces +--- +title: "Use Dapr PubSub with Multiple Namespaces" +linkTitle: "Multiple Namespaces" +weight: 1000 +--- In some scenarios, applications can be spread across namespaces and share a queue or topic via PubSub. In this case, the PubSub component must be provisioned on each namespace. diff --git a/OLD/howto/pubsub-scopes/README.md b/daprdocs/content/en/docs/building-blocks/pubsub/pubsub-scopes.md similarity index 98% rename from OLD/howto/pubsub-scopes/README.md rename to daprdocs/content/en/docs/building-blocks/pubsub/pubsub-scopes.md index 95b05a36c..28bc16953 100644 --- a/OLD/howto/pubsub-scopes/README.md +++ b/daprdocs/content/en/docs/building-blocks/pubsub/pubsub-scopes.md @@ -1,4 +1,8 @@ -# Limit the Pub/Sub topics used or scope them to one or more applications +--- +title: "Limit Application Pub/Sub Topics with Scopes" +linkTitle: "State Management" +weight: 2000 +--- [Namespaces or component scopes](../components-scopes/README.md) can be used to limit component access to particular applications. These application scopes added to a component limit only the applications with specific IDs to be able to use the component. diff --git a/OLD/howto/get-secrets/README.md b/daprdocs/content/en/docs/building-blocks/secrets/guide-secrets.md similarity index 97% rename from OLD/howto/get-secrets/README.md rename to daprdocs/content/en/docs/building-blocks/secrets/guide-secrets.md index 4b0d6cf04..1fbc2a438 100644 --- a/OLD/howto/get-secrets/README.md +++ b/daprdocs/content/en/docs/building-blocks/secrets/guide-secrets.md @@ -1,4 +1,8 @@ -# Access Application Secrets using the Secrets API +--- +title: "Guide: Get Secrets with the Dapr Secrets API" +linkTitle: "Guide: Secrets" +weight: 1000 +--- It's common for applications to store sensitive information such as connection strings, keys and tokens that are used to authenticate with databases, services and external systems in secrets by using a dedicated secret store. diff --git a/OLD/howto/invoke-and-discover-services/README.md b/daprdocs/content/en/docs/building-blocks/service-invocation/invoke-discover-services.md similarity index 94% rename from OLD/howto/invoke-and-discover-services/README.md rename to daprdocs/content/en/docs/building-blocks/service-invocation/invoke-discover-services.md index f6ff6ec16..dcd45b129 100644 --- a/OLD/howto/invoke-and-discover-services/README.md +++ b/daprdocs/content/en/docs/building-blocks/service-invocation/invoke-discover-services.md @@ -1,3 +1,10 @@ +--- +title: "Guide: Invoke & Discover Services" +linkTitle: "Guide: Invoke & Discover Services" +description: "This guide will walk you through configuring and invoking services using dapr" +weight: 100 +--- + # Invoke remote services In many environments with multiple services that need to communicate with each other, developers often ask themselves the following questions: diff --git a/daprdocs/content/en/docs/building-blocks/state-management/_index.md b/daprdocs/content/en/docs/building-blocks/state-management/_index.md index c58d07698..9238194a0 100644 --- a/daprdocs/content/en/docs/building-blocks/state-management/_index.md +++ b/daprdocs/content/en/docs/building-blocks/state-management/_index.md @@ -1,7 +1,7 @@ --- title: "Dapr State Management" linkTitle: "State Management" -weight: 20 +weight: 100 --- # State management diff --git a/OLD/howto/create-stateful-service/README.md b/daprdocs/content/en/docs/building-blocks/state-management/guide-get-save-state.md similarity index 95% rename from OLD/howto/create-stateful-service/README.md rename to daprdocs/content/en/docs/building-blocks/state-management/guide-get-save-state.md index 873fcc4ac..dc1f5912e 100644 --- a/OLD/howto/create-stateful-service/README.md +++ b/daprdocs/content/en/docs/building-blocks/state-management/guide-get-save-state.md @@ -1,3 +1,9 @@ +--- +title: "Guide: Save and Get State Using Dapr" +linkTitle: "Guide: Save/Get State" +weight: 200 +--- + # Create a stateful service State management is one of the most common needs of any application: new or legacy, monolith or microservice. diff --git a/OLD/howto/stateful-replicated-service/README.md b/daprdocs/content/en/docs/building-blocks/state-management/guide-stateful-service.md similarity index 98% rename from OLD/howto/stateful-replicated-service/README.md rename to daprdocs/content/en/docs/building-blocks/state-management/guide-stateful-service.md index 4ad312f2c..7b531f769 100644 --- a/OLD/howto/stateful-replicated-service/README.md +++ b/daprdocs/content/en/docs/building-blocks/state-management/guide-stateful-service.md @@ -1,4 +1,8 @@ -# Create a stateful replicated service +--- +title: "Create a stateful replicated service" +linkTitle: "Guide: Stateful Service" +weight: 300 +--- In this HowTo we'll show you how you can create a stateful service which can be horizontally scaled, using opt-in concurrency and consistency models. diff --git a/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/_index.md b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/_index.md new file mode 100644 index 000000000..2296c1975 --- /dev/null +++ b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/_index.md @@ -0,0 +1,5 @@ +--- +title: "Query Backend State Store" +linkTitle: "Query State Store" +weight: 100 +--- diff --git a/OLD/howto/query-state-store/query-cosmosdb-store.md b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-cosmosdb-store.md similarity index 96% rename from OLD/howto/query-state-store/query-cosmosdb-store.md rename to daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-cosmosdb-store.md index 367a308cc..fd3cf6cdb 100644 --- a/OLD/howto/query-state-store/query-cosmosdb-store.md +++ b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-cosmosdb-store.md @@ -1,4 +1,8 @@ -# Query Azure Cosmos DB state store +--- +title: "Query CosmosDB Store" +linkTitle: "Query CosmosDB" +weight: 1000 +--- Dapr doesn't transform state values while saving and retrieving states. Dapr requires all state store implementations to abide by a certain key format scheme (see [Dapr state management spec](../../reference/api/state_api.md). You can directly interact with the underlying store to manipulate the state data, such querying states, creating aggregated views and making backups. diff --git a/OLD/howto/query-state-store/query-redis-store.md b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-redis-store.md similarity index 96% rename from OLD/howto/query-state-store/query-redis-store.md rename to daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-redis-store.md index ddb325778..2082402cf 100644 --- a/OLD/howto/query-state-store/query-redis-store.md +++ b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-redis-store.md @@ -1,4 +1,8 @@ -# Query Redis state store +--- +title: "Query Redis Store" +linkTitle: "Query Redis" +weight: 2000 +--- Dapr doesn't transform state values while saving and retrieving states. Dapr requires all state store implementations to abide by a certain key format scheme (see [Dapr state management spec](../../reference/api/state_api.md). You can directly interact with the underlying store to manipulate the state data, such querying states, creating aggregated views and making backups. diff --git a/OLD/howto/query-state-store/query-sqlserver-store.md b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-sqlserver-store.md similarity index 97% rename from OLD/howto/query-state-store/query-sqlserver-store.md rename to daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-sqlserver-store.md index 33cda5156..7e7fdeb71 100644 --- a/OLD/howto/query-state-store/query-sqlserver-store.md +++ b/daprdocs/content/en/docs/building-blocks/state-management/query-state-store/query-sqlserver-store.md @@ -1,4 +1,8 @@ -# Query SQL Server state store +--- +title: "Query SQL Store" +linkTitle: "Query SQL" +weight: 3000 +--- Dapr doesn't transform state values while saving and retrieving states. Dapr requires all state store implementations to abide by a certain key format scheme (see [Dapr state management spec](../../reference/api/state_api.md). You can directly interact with the underlying store to manipulate the state data, such querying states, creating aggregated views and making backups. diff --git a/daprdocs/content/en/docs/deploying/components/_index.md b/daprdocs/content/en/docs/deploying/components/_index.md new file mode 100644 index 000000000..fe9ac668d --- /dev/null +++ b/daprdocs/content/en/docs/deploying/components/_index.md @@ -0,0 +1,5 @@ +--- +title: "Dapr Components" +linkTitle: "Components" +weight: 300 +--- \ No newline at end of file diff --git a/OLD/howto/components-scopes/README.md b/daprdocs/content/en/docs/deploying/components/component-scopes.md similarity index 94% rename from OLD/howto/components-scopes/README.md rename to daprdocs/content/en/docs/deploying/components/component-scopes.md index 70d79d2fc..814e433a5 100644 --- a/OLD/howto/components-scopes/README.md +++ b/daprdocs/content/en/docs/deploying/components/component-scopes.md @@ -1,4 +1,8 @@ -# Scope components to be used by one or more applications +--- +title: "Scope components to one or more applications" +linkTitle: "Scoping" +weight: 1000 +--- There are two things to know about Dapr components in terms of security and access. First, Dapr components are namespaced. That means a Dapr runtime instance can only access components that have been deployed to the same namespace. diff --git a/daprdocs/content/en/docs/building-blocks/secrets/component-secrets.md b/daprdocs/content/en/docs/deploying/components/component-secrets.md similarity index 98% rename from daprdocs/content/en/docs/building-blocks/secrets/component-secrets.md rename to daprdocs/content/en/docs/deploying/components/component-secrets.md index cd0166cb9..2f2385e4f 100644 --- a/daprdocs/content/en/docs/building-blocks/secrets/component-secrets.md +++ b/daprdocs/content/en/docs/deploying/components/component-secrets.md @@ -1,11 +1,9 @@ --- title: "Referencing Secret Stores in Components" linkTitle: "Referencing Secrets" -weight: 1 +weight: 2000 --- -# Referencing Secret Stores in Components - Components can reference secrets for the `spec.metadata` section. In order to reference a secret, you need to set the `auth.secretStore` field to specify the name of the secret store that holds the secrets. diff --git a/daprdocs/content/en/docs/deploying/configuration/_index.md b/daprdocs/content/en/docs/deploying/configuration/_index.md new file mode 100644 index 000000000..56092bfa5 --- /dev/null +++ b/daprdocs/content/en/docs/deploying/configuration/_index.md @@ -0,0 +1,5 @@ +--- +title: "Dapr Configuration" +linkTitle: "Configuration" +weight: 400 +--- \ No newline at end of file diff --git a/OLD/howto/control-concurrency/README.md b/daprdocs/content/en/docs/deploying/configuration/control-concurrency.md similarity index 94% rename from OLD/howto/control-concurrency/README.md rename to daprdocs/content/en/docs/deploying/configuration/control-concurrency.md index 501f01212..637288fbb 100644 --- a/OLD/howto/control-concurrency/README.md +++ b/daprdocs/content/en/docs/deploying/configuration/control-concurrency.md @@ -1,3 +1,9 @@ +--- +title: "Control Concurrency and Rate Limit Applications" +linkTitle: "Concurrency" +weight: 1000 +--- + # Rate limiting an application A common scenario in distributed computing is to only allow for a given number of requests to execute concurrently. diff --git a/OLD/howto/create-grpc-app/README.md b/daprdocs/content/en/docs/deploying/configuration/guide-gRPC.md similarity index 98% rename from OLD/howto/create-grpc-app/README.md rename to daprdocs/content/en/docs/deploying/configuration/guide-gRPC.md index 56c621ae9..4ccdaf29b 100644 --- a/OLD/howto/create-grpc-app/README.md +++ b/daprdocs/content/en/docs/deploying/configuration/guide-gRPC.md @@ -1,3 +1,9 @@ +--- +title: "Guide: Use gRPC Interface" +linkTitle: "Referencing Secrets" +weight: 2000 +--- + # Dapr and gRPC Dapr implements both an http API and a gRPC interface. diff --git a/OLD/howto/configure-k8s/README.md b/daprdocs/content/en/docs/deploying/kubernetes/_index.md similarity index 98% rename from OLD/howto/configure-k8s/README.md rename to daprdocs/content/en/docs/deploying/kubernetes/_index.md index bc14b2fb0..d3a6941bd 100644 --- a/OLD/howto/configure-k8s/README.md +++ b/daprdocs/content/en/docs/deploying/kubernetes/_index.md @@ -1,4 +1,8 @@ -# Configuring the Dapr sidecar on Kubernetes +--- +title: "Run Dapr in Kubernetes Mode" +linkTitle: "Kubernetes" +weight: 200 +--- On Kubernetes, Dapr uses a sidecar injector pod that automatically injects the Dapr sidecar container into a pod that has the correct annotations. The sidecar injector is an implementation of a Kubernetes [Admission Controller](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/). diff --git a/OLD/howto/autoscale-with-keda/README.md b/daprdocs/content/en/docs/deploying/kubernetes/autoscale-keda.md similarity index 96% rename from OLD/howto/autoscale-with-keda/README.md rename to daprdocs/content/en/docs/deploying/kubernetes/autoscale-keda.md index b63182081..c8aa43071 100644 --- a/OLD/howto/autoscale-with-keda/README.md +++ b/daprdocs/content/en/docs/deploying/kubernetes/autoscale-keda.md @@ -1,4 +1,8 @@ -# Autoscaling a Dapr app with KEDA +--- +title: "Autoscaling a Dapr app with KEDA" +linkTitle: "Autoscale" +weight: 3000 +--- Dapr is a programming model that's being installed and operated using a sidecar, and thus leaves autoscaling to the hosting layer, for example Kubernetes. Many of Dapr's [bindings](../../concepts/bindings#supported-bindings-and-specs) overlap with those of [KEDA](https://github.com/kedacore/keda), an Event Driven Autoscaler for Kubernetes. diff --git a/OLD/howto/windows-k8s/README.md b/daprdocs/content/en/docs/deploying/kubernetes/hybrid-clusters.md similarity index 98% rename from OLD/howto/windows-k8s/README.md rename to daprdocs/content/en/docs/deploying/kubernetes/hybrid-clusters.md index 92eb989fe..3e1bf502e 100644 --- a/OLD/howto/windows-k8s/README.md +++ b/daprdocs/content/en/docs/deploying/kubernetes/hybrid-clusters.md @@ -1,4 +1,8 @@ -# Deploy to hybrid Linux/Windows Kubernetes clusters +--- +title: "Deploy to hybrid Linux/Windows Kubernetes clusters" +linkTitle: "Hybrid Clusters" +weight: 2000 +--- Dapr supports running on kubernetes clusters with windows nodes. You can run your Dapr microservices exclusively on Windows, exclusively on Linux, or a combination of both. This is helpful to users who may be doing a piecemeal migration of a legacy application into a Dapr Kubernetes cluster. diff --git a/OLD/howto/deploy-k8s-prod/README.md b/daprdocs/content/en/docs/deploying/kubernetes/prod-kubernetes.md similarity index 98% rename from OLD/howto/deploy-k8s-prod/README.md rename to daprdocs/content/en/docs/deploying/kubernetes/prod-kubernetes.md index 2e72be733..07d4f4968 100644 --- a/OLD/howto/deploy-k8s-prod/README.md +++ b/daprdocs/content/en/docs/deploying/kubernetes/prod-kubernetes.md @@ -1,4 +1,8 @@ -# Guidelines for production ready deployments on Kubernetes +--- +title: "Guidelines for production ready deployments on Kubernetes" +linkTitle: "Production" +weight: 1000 +--- This section outlines recommendations and practices for deploying Dapr to a Kubernetes cluster in a production ready configuration. diff --git a/daprdocs/content/en/docs/deploying/security/_index.md b/daprdocs/content/en/docs/deploying/security/_index.md new file mode 100644 index 000000000..1f2fb50eb --- /dev/null +++ b/daprdocs/content/en/docs/deploying/security/_index.md @@ -0,0 +1,5 @@ +--- +title: "Securing Dapr Deployments" +linkTitle: "Security" +weight: 500 +--- \ No newline at end of file diff --git a/OLD/howto/enable-dapr-api-token-based-authentication/README.md b/daprdocs/content/en/docs/deploying/security/api-token.md similarity index 96% rename from OLD/howto/enable-dapr-api-token-based-authentication/README.md rename to daprdocs/content/en/docs/deploying/security/api-token.md index ddc7d08ea..1b69321d0 100644 --- a/OLD/howto/enable-dapr-api-token-based-authentication/README.md +++ b/daprdocs/content/en/docs/deploying/security/api-token.md @@ -1,4 +1,8 @@ -# Enable Dapr APIs token-based authentication +--- +title: "Enable API Token Based Authentication" +linkTitle: "API Token Auth" +weight: 3000 +--- By default, Dapr relies on the network boundary to limit access to its public API. If you plan on exposing the Dapr API outside of that boundary, or if your deployment demands an additional level of security, consider enabling the token authentication for Dapr APIs. This will cause Dapr to require every incoming gRPC and HTTP request for its APIs for to include authentication token, before allowing that request to pass through. diff --git a/OLD/howto/configure-mtls/README.md b/daprdocs/content/en/docs/deploying/security/mtls.md similarity index 99% rename from OLD/howto/configure-mtls/README.md rename to daprdocs/content/en/docs/deploying/security/mtls.md index 9209ea0a6..d17aaceb7 100644 --- a/OLD/howto/configure-mtls/README.md +++ b/daprdocs/content/en/docs/deploying/security/mtls.md @@ -1,4 +1,8 @@ -# Setup and configure mutual TLS +--- +title: "Setup & configure mutual TLS" +linkTitle: "mTLS" +weight: 1000 +--- Dapr supports in-transit encryption of communication between Dapr instances using Sentry, a central Certificate Authority. diff --git a/OLD/howto/authorization-with-oauth/README.md b/daprdocs/content/en/docs/deploying/security/oauth.md similarity index 98% rename from OLD/howto/authorization-with-oauth/README.md rename to daprdocs/content/en/docs/deploying/security/oauth.md index ecad2e8c2..e20ebdfcf 100644 --- a/OLD/howto/authorization-with-oauth/README.md +++ b/daprdocs/content/en/docs/deploying/security/oauth.md @@ -1,4 +1,8 @@ -# Configure API authorization with OAuth +--- +title: "Configure API Authention with OAUTH" +linkTitle: "OAuth" +weight: 2000 +--- Dapr OAuth 2.0 [middleware](../../concepts/middleware/README.md) allows you to enable [OAuth](https://oauth.net/2/) authorization on Dapr endpoints for your web APIs, diff --git a/daprdocs/content/en/docs/deploying/self-hosted/_index.md b/daprdocs/content/en/docs/deploying/self-hosted/_index.md new file mode 100644 index 000000000..255a512f7 --- /dev/null +++ b/daprdocs/content/en/docs/deploying/self-hosted/_index.md @@ -0,0 +1,5 @@ +--- +title: "Run Dapr in Self Hosted Mode" +linkTitle: "Self-Hosted" +weight: 100 +--- \ No newline at end of file diff --git a/OLD/howto/self-hosted-no-docker/README.md b/daprdocs/content/en/docs/deploying/self-hosted/self-hosted-no-docker.md similarity index 97% rename from OLD/howto/self-hosted-no-docker/README.md rename to daprdocs/content/en/docs/deploying/self-hosted/self-hosted-no-docker.md index e429625f4..433eed156 100644 --- a/OLD/howto/self-hosted-no-docker/README.md +++ b/daprdocs/content/en/docs/deploying/self-hosted/self-hosted-no-docker.md @@ -1,3 +1,9 @@ +--- +title: "Run Dapr in Self Hosted Mode Without Docker" +linkTitle: "Without Docker" +weight: 2000 +--- + # Self hosted mode without containers This article provides guidance on running Dapr in self-hosted mode without Docker. diff --git a/OLD/howto/run-with-docker/README.md b/daprdocs/content/en/docs/deploying/self-hosted/self-hosted-with-docker.md similarity index 98% rename from OLD/howto/run-with-docker/README.md rename to daprdocs/content/en/docs/deploying/self-hosted/self-hosted-with-docker.md index 4e7fa7e46..41119e1fc 100644 --- a/OLD/howto/run-with-docker/README.md +++ b/daprdocs/content/en/docs/deploying/self-hosted/self-hosted-with-docker.md @@ -1,3 +1,9 @@ +--- +title: "Run Dapr in Self Hosted Mode with Docker" +linkTitle: "Run with Docker" +weight: 1000 +--- + # Run with Docker This article provides guidance on running Dapr with Docker outside of Kubernetes. There are a number of different configurations in which you may wish to run Dapr with Docker that are documented below. diff --git a/OLD/best-practices/troubleshooting/README.md b/daprdocs/content/en/docs/deploying/troubleshooting/_index.md similarity index 85% rename from OLD/best-practices/troubleshooting/README.md rename to daprdocs/content/en/docs/deploying/troubleshooting/_index.md index c7edbe5ba..7dd3b9bdd 100644 --- a/OLD/best-practices/troubleshooting/README.md +++ b/daprdocs/content/en/docs/deploying/troubleshooting/_index.md @@ -1,4 +1,8 @@ -# Debugging and Troubleshooting +--- +title: "Debugging and Troubleshooting" +linkTitle: "Troubleshooting" +weight: 700 +--- This section describes different tools, techniques and common problems to help users debug and diagnose issues with Dapr. diff --git a/OLD/best-practices/troubleshooting/common_issues.md b/daprdocs/content/en/docs/deploying/troubleshooting/common_issues.md similarity index 99% rename from OLD/best-practices/troubleshooting/common_issues.md rename to daprdocs/content/en/docs/deploying/troubleshooting/common_issues.md index 54d3f2230..8b0fe9fe4 100644 --- a/OLD/best-practices/troubleshooting/common_issues.md +++ b/daprdocs/content/en/docs/deploying/troubleshooting/common_issues.md @@ -1,4 +1,8 @@ -# Common Issues +--- +title: "Common Issues" +linkTitle: "Common Issues" +weight: 1000 +--- This section will walk you through some common issues and problems. diff --git a/OLD/best-practices/troubleshooting/logs.md b/daprdocs/content/en/docs/deploying/troubleshooting/logs.md similarity index 99% rename from OLD/best-practices/troubleshooting/logs.md rename to daprdocs/content/en/docs/deploying/troubleshooting/logs.md index 6ca69fcc2..6c1ccb639 100644 --- a/OLD/best-practices/troubleshooting/logs.md +++ b/daprdocs/content/en/docs/deploying/troubleshooting/logs.md @@ -1,4 +1,8 @@ -# Logs +--- +title: "Dapr Logs" +linkTitle: "Logs" +weight: 2000 +--- This section will assist you in understanding how logging works in Dapr, configuring and viewing logs. diff --git a/OLD/best-practices/troubleshooting/profiling_debugging.md b/daprdocs/content/en/docs/deploying/troubleshooting/profiling_debugging.md similarity index 98% rename from OLD/best-practices/troubleshooting/profiling_debugging.md rename to daprdocs/content/en/docs/deploying/troubleshooting/profiling_debugging.md index 173f4f646..bbdc5249c 100644 --- a/OLD/best-practices/troubleshooting/profiling_debugging.md +++ b/daprdocs/content/en/docs/deploying/troubleshooting/profiling_debugging.md @@ -1,4 +1,8 @@ -# Profiling and Debugging +--- +title: "Profiling & Debugging" +linkTitle: "Debugging" +weight: 4000 +--- In any real world scenario, an app might start exhibiting undesirable behavior in terms of resource spikes. CPU/Memory spikes are not uncommon in most cases. diff --git a/OLD/best-practices/troubleshooting/tracing.md b/daprdocs/content/en/docs/deploying/troubleshooting/tracing.md similarity index 98% rename from OLD/best-practices/troubleshooting/tracing.md rename to daprdocs/content/en/docs/deploying/troubleshooting/tracing.md index a58193839..98cf8e3db 100644 --- a/OLD/best-practices/troubleshooting/tracing.md +++ b/daprdocs/content/en/docs/deploying/troubleshooting/tracing.md @@ -1,4 +1,8 @@ -# Tracing +--- +title: "Tracing" +linkTitle: "Tracing" +weight: 3000 +--- Dapr integrates with Open Census for telemetry and tracing. diff --git a/daprdocs/content/en/docs/getting-started/environment-setup.md b/daprdocs/content/en/docs/getting-started/install-dapr.md similarity index 100% rename from daprdocs/content/en/docs/getting-started/environment-setup.md rename to daprdocs/content/en/docs/getting-started/install-dapr.md diff --git a/daprdocs/content/en/docs/integrations/ides/_index.md b/daprdocs/content/en/docs/integrations/ides/_index.md new file mode 100644 index 000000000..9b5dbba0f --- /dev/null +++ b/daprdocs/content/en/docs/integrations/ides/_index.md @@ -0,0 +1,5 @@ +--- +title: "Dapr IDE Integrations" +linkTitle: "IDEs" +weight: 200 +--- \ No newline at end of file diff --git a/OLD/howto/intellij-debugging-daprd/README.md b/daprdocs/content/en/docs/integrations/ides/intellij.md similarity index 97% rename from OLD/howto/intellij-debugging-daprd/README.md rename to daprdocs/content/en/docs/integrations/ides/intellij.md index 0b2bb7d0a..1607a0817 100644 --- a/OLD/howto/intellij-debugging-daprd/README.md +++ b/daprdocs/content/en/docs/integrations/ides/intellij.md @@ -1,4 +1,8 @@ -# Configuring IntelliJ Community Edition for debugging with Dapr +--- +title: "Configuring IntelliJ Community Edition for debugging with Dapr" +linkTitle: "IntelliJ" +weight: 1000 +--- When developing Dapr applications, you typically use the Dapr CLI to start your 'Daprized' service similar to this: diff --git a/OLD/howto/vscode-debugging-daprd/README.md b/daprdocs/content/en/docs/integrations/ides/vscode-debugging.md similarity index 98% rename from OLD/howto/vscode-debugging-daprd/README.md rename to daprdocs/content/en/docs/integrations/ides/vscode-debugging.md index d69766df4..dd7e9da80 100644 --- a/OLD/howto/vscode-debugging-daprd/README.md +++ b/daprdocs/content/en/docs/integrations/ides/vscode-debugging.md @@ -1,4 +1,8 @@ -# Application development with Visual Studio Code +--- +title: "Application development and debugging with Visual Studio Code" +linkTitle: "VSCode Debugging" +weight: 2000 +--- ## Visual Studio Code Dapr extension It is recommended to use the *preview* of the [Dapr Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-dapr) available in the Visual Studio marketplace for local development and debugging of your Dapr applications. diff --git a/OLD/howto/vscode-remote-containers/README.md b/daprdocs/content/en/docs/integrations/ides/vscode-remotecontainers.md similarity index 88% rename from OLD/howto/vscode-remote-containers/README.md rename to daprdocs/content/en/docs/integrations/ides/vscode-remotecontainers.md index 1f63b7149..6cac4e42d 100644 --- a/OLD/howto/vscode-remote-containers/README.md +++ b/daprdocs/content/en/docs/integrations/ides/vscode-remotecontainers.md @@ -1,4 +1,8 @@ -# Application development with Visual Studio Code +--- +title: "Application development and debugging with Visual Studio Code rmeote containers" +linkTitle: "VSCode Remote Containers" +weight: 3000 +--- ## Using remote containers for your application development diff --git a/daprdocs/content/en/docs/integrations/monitoring-tools/_index.md b/daprdocs/content/en/docs/integrations/monitoring-tools/_index.md new file mode 100644 index 000000000..e266fda0d --- /dev/null +++ b/daprdocs/content/en/docs/integrations/monitoring-tools/_index.md @@ -0,0 +1,5 @@ +--- +title: "Dapr Integrations with Monitoring Tools" +linkTitle: "Monitoring" +weight: 400 +--- \ No newline at end of file diff --git a/OLD/howto/setup-monitoring-tools/azm-config-map.yaml b/daprdocs/content/en/docs/integrations/monitoring-tools/azm-config-map.yaml similarity index 100% rename from OLD/howto/setup-monitoring-tools/azm-config-map.yaml rename to daprdocs/content/en/docs/integrations/monitoring-tools/azm-config-map.yaml diff --git a/OLD/howto/setup-monitoring-tools/setup-azure-monitor.md b/daprdocs/content/en/docs/integrations/monitoring-tools/azure-monitor.md similarity index 97% rename from OLD/howto/setup-monitoring-tools/setup-azure-monitor.md rename to daprdocs/content/en/docs/integrations/monitoring-tools/azure-monitor.md index 9bb9194e5..82ea51db9 100644 --- a/OLD/howto/setup-monitoring-tools/setup-azure-monitor.md +++ b/daprdocs/content/en/docs/integrations/monitoring-tools/azure-monitor.md @@ -1,4 +1,8 @@ -# Set up Azure Monitor to search logs and collect metrics +--- +title: "Set up Azure Monitor to search logs and collect metrics" +linkTitle: "Azure Monitor" +weight: 2000 +--- This document describes how to enable Dapr metrics and logs with Azure Monitor for Azure Kubernetes Service (AKS). diff --git a/OLD/howto/setup-monitoring-tools/fluentd-config-map.yaml b/daprdocs/content/en/docs/integrations/monitoring-tools/fluentd-config-map.yaml similarity index 100% rename from OLD/howto/setup-monitoring-tools/fluentd-config-map.yaml rename to daprdocs/content/en/docs/integrations/monitoring-tools/fluentd-config-map.yaml diff --git a/OLD/howto/setup-monitoring-tools/fluentd-dapr-with-rbac.yaml b/daprdocs/content/en/docs/integrations/monitoring-tools/fluentd-dapr-with-rbac.yaml similarity index 100% rename from OLD/howto/setup-monitoring-tools/fluentd-dapr-with-rbac.yaml rename to daprdocs/content/en/docs/integrations/monitoring-tools/fluentd-dapr-with-rbac.yaml diff --git a/OLD/howto/setup-monitoring-tools/setup-fluentd-es-kibana.md b/daprdocs/content/en/docs/integrations/monitoring-tools/fluentd.md similarity index 98% rename from OLD/howto/setup-monitoring-tools/setup-fluentd-es-kibana.md rename to daprdocs/content/en/docs/integrations/monitoring-tools/fluentd.md index c9a2e5336..c7f0c05c9 100644 --- a/OLD/howto/setup-monitoring-tools/setup-fluentd-es-kibana.md +++ b/daprdocs/content/en/docs/integrations/monitoring-tools/fluentd.md @@ -1,4 +1,8 @@ -# Set up Fluentd, Elastic search and Kibana in Kubernetes +--- +title: "Set up Fluentd, Elastic search and Kibana in Kubernetes" +linkTitle: "FluentD" +weight: 1000 +--- This document descriebs how to install Fluentd, Elastic Search, and Kibana to search logs in Kubernetes diff --git a/OLD/howto/setup-monitoring-tools/observe-metrics-with-grafana.md b/daprdocs/content/en/docs/integrations/monitoring-tools/grafana.md similarity index 98% rename from OLD/howto/setup-monitoring-tools/observe-metrics-with-grafana.md rename to daprdocs/content/en/docs/integrations/monitoring-tools/grafana.md index 38aee9b7c..27d354f2e 100644 --- a/OLD/howto/setup-monitoring-tools/observe-metrics-with-grafana.md +++ b/daprdocs/content/en/docs/integrations/monitoring-tools/grafana.md @@ -1,4 +1,8 @@ -# Observe metrics with Grafana +--- +title: "Observe metrics with Grafana" +linkTitle: "Grafana" +weight: 3000 +--- This document describes how to view Dapr metrics in a Grafana dashboard. You can see example screenshots of the Dapr dashboards [here](../../reference/dashboard/img/). diff --git a/OLD/howto/setup-monitoring-tools/img/grafana-add-datasources.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-add-datasources.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/grafana-add-datasources.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-add-datasources.png diff --git a/OLD/howto/setup-monitoring-tools/img/grafana-datasources.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-datasources.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/grafana-datasources.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-datasources.png diff --git a/OLD/howto/setup-monitoring-tools/img/grafana-prometheus-dapr-server-url.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-prometheus-dapr-server-url.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/grafana-prometheus-dapr-server-url.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-prometheus-dapr-server-url.png diff --git a/OLD/howto/setup-monitoring-tools/img/grafana-uploadjson.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-uploadjson.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/grafana-uploadjson.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/grafana-uploadjson.png diff --git a/OLD/howto/setup-monitoring-tools/img/kibana-1.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-1.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/kibana-1.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-1.png diff --git a/OLD/howto/setup-monitoring-tools/img/kibana-2.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-2.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/kibana-2.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-2.png diff --git a/OLD/howto/setup-monitoring-tools/img/kibana-3.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-3.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/kibana-3.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-3.png diff --git a/OLD/howto/setup-monitoring-tools/img/kibana-4.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-4.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/kibana-4.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-4.png diff --git a/OLD/howto/setup-monitoring-tools/img/kibana-5.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-5.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/kibana-5.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-5.png diff --git a/OLD/howto/setup-monitoring-tools/img/kibana-6.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-6.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/kibana-6.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-6.png diff --git a/OLD/howto/setup-monitoring-tools/img/kibana-7.png b/daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-7.png similarity index 100% rename from OLD/howto/setup-monitoring-tools/img/kibana-7.png rename to daprdocs/content/en/docs/integrations/monitoring-tools/img/kibana-7.png diff --git a/OLD/howto/setup-monitoring-tools/setup-prometheus-grafana.md b/daprdocs/content/en/docs/integrations/monitoring-tools/prometheus-grafana.md similarity index 97% rename from OLD/howto/setup-monitoring-tools/setup-prometheus-grafana.md rename to daprdocs/content/en/docs/integrations/monitoring-tools/prometheus-grafana.md index b3f96523e..2d200b6ce 100644 --- a/OLD/howto/setup-monitoring-tools/setup-prometheus-grafana.md +++ b/daprdocs/content/en/docs/integrations/monitoring-tools/prometheus-grafana.md @@ -1,4 +1,8 @@ -# Set up Prometheus and Grafana in Kubernetes +--- +title: "Set up Prometheus and Grafana in Kubernetes" +linkTitle: "Prometheus/Grafana" +weight: 5000 +--- This document describes how to install Prometheus and Grafana on a Kubernetes cluster which can then be used to view the Dapr metrics dashboards. diff --git a/OLD/howto/setup-monitoring-tools/observe-metrics-with-prometheus-locally.md b/daprdocs/content/en/docs/integrations/monitoring-tools/prometheus.md similarity index 96% rename from OLD/howto/setup-monitoring-tools/observe-metrics-with-prometheus-locally.md rename to daprdocs/content/en/docs/integrations/monitoring-tools/prometheus.md index d1e79af5a..c58189690 100644 --- a/OLD/howto/setup-monitoring-tools/observe-metrics-with-prometheus-locally.md +++ b/daprdocs/content/en/docs/integrations/monitoring-tools/prometheus.md @@ -1,4 +1,8 @@ -# Observe Metrics with Prometheus locally +--- +title: "Observe Metrics with Prometheus locally" +linkTitle: "Prometheus" +weight: 4000 +--- Dapr exposes a Prometheus metrics endpoint you can use to collect time-series data relating to the execution of the Dapr runtime itself. diff --git a/daprdocs/content/en/docs/integrations/sdks/_index.md b/daprdocs/content/en/docs/integrations/sdks/_index.md new file mode 100644 index 000000000..fc69c1624 --- /dev/null +++ b/daprdocs/content/en/docs/integrations/sdks/_index.md @@ -0,0 +1,5 @@ +--- +title: "Dapr Developer SDKs" +linkTitle: "SDKs" +weight: 100 +--- \ No newline at end of file diff --git a/OLD/howto/serialize/README.md b/daprdocs/content/en/docs/integrations/sdks/serialization.md similarity index 97% rename from OLD/howto/serialize/README.md rename to daprdocs/content/en/docs/integrations/sdks/serialization.md index 4f6893729..7b1b0f057 100644 --- a/OLD/howto/serialize/README.md +++ b/daprdocs/content/en/docs/integrations/sdks/serialization.md @@ -1,4 +1,8 @@ -# Serialization in Dapr's SDKs +--- +title: "Serialization in Dapr's SDKs" +linkTitle: "Serialization" +weight: 1000 +--- An SDK for Dapr should provide serialization for two use cases. First, for API objects sent through request and response payloads. Second, for objects to be persisted. For both these use cases, a default serialization is provided. In the Java SDK, it is the [DefaultObjectSerializer](https://dapr.github.io/java-sdk/io/dapr/serializer/DefaultObjectSerializer.html) class, providing JSON serialization.