Skip to content
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
2 changes: 2 additions & 0 deletions .github/workflows/scheduled-generated.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ jobs:
run: |
git remote add -f -t main --no-tags examples https://github.com/score-spec/examples.git
git remote add -f -t main --no-tags community-provisioners https://github.com/score-spec/community-provisioners.git
git remote add -f -t main --no-tags score-compose https://github.com/score-spec/score-compose.git
git remote add -f -t main --no-tags score-k8s https://github.com/score-spec/score-k8s.git
git remote add -f -t main --no-tags patch-templates https://github.com/score-spec/community-patchers.git

# Set github actions bot as the committer, see https://github.com/actions/checkout/pull/1184
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,15 @@ The commands for the initial integration of the repos are:
```bash
git remote add -f -t main --no-tags examples https://github.com/score-spec/examples.git
git remote add -f -t main --no-tags community-provisioners https://github.com/score-spec/community-provisioners.git
git remote add -f -t main --no-tags score-compose https://github.com/score-spec/score-compose.git
git remote add -f -t main --no-tags score-k8s https://github.com/score-spec/score-k8s.git
git remote add -f -t main --no-tags patch-templates https://github.com/score-spec/community-patchers.git
git read-tree --prefix=gen/external-content/score/specification -u examples/main:specification
git read-tree --prefix=gen/external-content/resource-provisioners/default/score-compose -u score-compose/main:internal/command
git read-tree --prefix=gen/external-content/score/resources/default-provisioners -u examples/main:resources
git read-tree --prefix=gen/external-content/score/resources/community-provisioners -u community-provisioners/main
git read-tree --prefix=gen/external-content/resource-provisioners/default/score-k8s -u score-k8s/main:internal/provisioners/default
git read-tree --prefix=gen/external-content/resource-provisioners/community -u community-provisioners/main
git read-tree --prefix=gen/external-content/patch-templates -u patch-templates/main
git add gen/external-content
git commit -s -S -m "Integrating external content"
Expand Down
6 changes: 6 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -163,12 +163,18 @@ url = "https://github.com/score-spec/examples/blob/main"
name = "score/resources/community-provisioners"
url = "https://github.com/score-spec/community-provisioners/blob/main"
[[Params.exampleLibraryGitHubUrls]]
name = "resource-provisioners/community"
url = "https://github.com/score-spec/community-provisioners/blob/main"
[[Params.exampleLibraryGitHubUrls]]
name = "patch-templates"
url = "https://github.com/score-spec/community-patchers/blob/main"
[[Params.exampleTypeLabels]]
name = "score"
labels = ["Specification", "Resources", "Provisioner"]
[[Params.exampleTypeLabels]]
name = "resource-provisioners"
labels = ["Source", "Implementation", "Provisioner Type", "Resource Type", "Flavor", "Tool"]
[[Params.exampleTypeLabels]]
name = "patch-templates"
labels = ["Implementation"]

Expand Down
4 changes: 4 additions & 0 deletions content/en/examples/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Explore a curated set of example files covering a range of entities for working
{{< link-card-item text="Find some Score files examples illustrating how to use the Score specification as well as how to use the resources provisioners with both `score-compose` and `score-k8s`." url="/examples/score" linkLabel="Get examples" >}}
{{< /multi-link-card >}}

{{< multi-link-card title="Resources provisioners" >}}
{{< link-card-item text="Find some Score files examples illustrating how to use the resources provisioners with both `score-compose` and `score-k8s`." url="/examples/resource-provisioners" linkLabel="Get examples" >}}
{{< /multi-link-card >}}

{{< multi-link-card title="Patch templates" >}}
{{< link-card-item text="Find some examples illustrating how to use the patch templates with both `score-compose` and `score-k8s`." url="/examples/patch-templates" linkLabel="Get examples" >}}
{{< /multi-link-card >}}
Expand Down
9 changes: 9 additions & 0 deletions content/en/examples/resource-provisioners/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Resource Provisioners"
draft: false
type: examples
---

The examples below illustrate how to use resources provisioners for each Score implementation.

---
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "redis-dapr-pubsub"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-compose"
resourceType: "dapr-pubsub"
provisionerType: "template"
flavor: "redis"
excerpt: ''
description: 'Generates a Dapr PubSub Component pointing to a Redis Service.'
expectedOutputs:
- name
hasMore: false

---

{{% resource-provisioner-content description="Generates a Dapr PubSub Component pointing to a Redis Service." type="dapr-pubsub" expectedOutputs="name" %}}

{{% example-file filename="10-redis-dapr-pubsub.provisioners.yaml" dir="resource-provisioners/community/dapr-pubsub/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "rabbitmq-dapr-pubsub"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-k8s"
resourceType: "dapr-pubsub"
provisionerType: "template"
flavor: "rabbitmq"
excerpt: ''
description: 'Generates a Dapr PubSub Component pointing to a RabbitMQ StatefulSet.'
expectedOutputs:
- name
hasMore: false

---

{{% resource-provisioner-content description="Generates a Dapr PubSub Component pointing to a RabbitMQ StatefulSet." type="dapr-pubsub" expectedOutputs="name" %}}

{{% example-file filename="10-rabbitmq-dapr-pubsub.provisioners.yaml" dir="resource-provisioners/community/dapr-pubsub/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "redis-dapr-pubsub"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-k8s"
resourceType: "dapr-pubsub"
provisionerType: "template"
flavor: "redis"
excerpt: ''
description: 'Generates a Dapr PubSub Component pointing to a Redis StatefulSet.'
expectedOutputs:
- name
hasMore: false

---

{{% resource-provisioner-content description="Generates a Dapr PubSub Component pointing to a Redis StatefulSet." type="dapr-pubsub" expectedOutputs="name" %}}

{{% example-file filename="10-redis-dapr-pubsub.provisioners.yaml" dir="resource-provisioners/community/dapr-pubsub/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "redis-dapr-state-store"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-compose"
resourceType: "dapr-state-store"
provisionerType: "template"
flavor: "redis"
excerpt: ''
description: 'Generates a Dapr StateStore Component pointing to a Redis Service.'
expectedOutputs:
- name
hasMore: false

---

{{% resource-provisioner-content description="Generates a Dapr StateStore Component pointing to a Redis Service." type="dapr-state-store" expectedOutputs="name" %}}

{{% example-file filename="10-redis-dapr-state-store.provisioners.yaml" dir="resource-provisioners/community/dapr-state-store/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "redis"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-k8s"
resourceType: "dapr-state-store"
provisionerType: "template"
flavor: "redis"
excerpt: ''
description: 'Generates a Dapr StateStore Component pointing to a Redis StatefulSet.'
expectedOutputs:
- name
hasMore: false

---

{{% resource-provisioner-content description="Generates a Dapr StateStore Component pointing to a Redis StatefulSet." type="dapr-state-store" expectedOutputs="name" %}}

{{% example-file filename="10-redis-dapr-state-store.provisioners.yaml" dir="resource-provisioners/community/dapr-state-store/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "dapr-subscription"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-compose"
resourceType: "dapr-subscription"
provisionerType: "template"
flavor: "dapr"
excerpt: ''
description: 'Generates a Dapr Subscription on a given Topic and PubSub.'
expectedOutputs:
- name
- topic
supportedParams:
- topic
- pubsub
hasMore: false

---

{{% resource-provisioner-content description="Generates a Dapr Subscription on a given Topic and PubSub." type="dapr-subscription" supportedParams="topic,pubsub" expectedOutputs="name,topic" %}}

{{% example-file filename="10-dapr-subscription.provisioners.yaml" dir="resource-provisioners/community/dapr-subscription/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "dapr-subscription"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-k8s"
resourceType: "dapr-subscription"
provisionerType: "template"
flavor: "dapr"
excerpt: ''
description: 'Generates a Dapr Subscription on a given Topic and PubSub.'
expectedOutputs:
- name
- topic
supportedParams:
- topic
- pubsub
hasMore: false

---

{{% resource-provisioner-content description="Generates a Dapr Subscription on a given Topic and PubSub." type="dapr-subscription" supportedParams="topic,pubsub" expectedOutputs="name,topic" %}}

{{% example-file filename="10-dapr-subscription.provisioners.yaml" dir="resource-provisioners/community/dapr-subscription/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "dns-in-codespace"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-compose"
resourceType: "dns"
provisionerType: "cmd"
flavor: "dns-in-codespace"
excerpt: 'Prerequisites for `dns-in-codespace`:
- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.'
description: 'Get the forwarded port URL in current GitHub Codespace on port 8080'
expectedOutputs:
- host
- url
tool: dns
hasMore: false

---

Prerequisites for `dns-in-codespace`:

- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.

{{% resource-provisioner-content description="Get the forwarded port URL in current GitHub Codespace on port 8080" type="dns" expectedOutputs="host,url" %}}

{{% example-file filename="10-dns-in-codespace.provisioners.yaml" dir="resource-provisioners/community/dns/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "dns-with-route"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-compose"
resourceType: "dns"
provisionerType: "template"
flavor: "dns"
excerpt: 'Prerequisites for `dns-in-codespace`:
- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.'
description: 'Outputs a *.localhost domain as the hostname and associated URL in http on port 8080'
expectedOutputs:
- host
- url
hasMore: false

---

Prerequisites for `dns-in-codespace`:

- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.

{{% resource-provisioner-content description="Outputs a *.localhost domain as the hostname and associated URL in http on port 8080" type="dns" expectedOutputs="host,url" %}}

{{% example-file filename="10-dns-with-url.provisioners.yaml" dir="resource-provisioners/community/dns/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "dns-in-codespace"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-k8s"
resourceType: "dns"
provisionerType: "cmd"
flavor: "dns-in-codespace"
excerpt: 'Prerequisites for `dns-in-codespace`:
- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.'
description: 'Get the forwarded port URL in current GitHub Codespace on port 80'
expectedOutputs:
- host
- url
tool: dns
hasMore: false

---

Prerequisites for `dns-in-codespace`:

- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.

{{% resource-provisioner-content description="Get the forwarded port URL in current GitHub Codespace on port 80" type="dns" expectedOutputs="host,url" %}}

{{% example-file filename="10-dns-in-codespace.provisioners.yaml" dir="resource-provisioners/community/dns/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "dns-with-url"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-k8s"
resourceType: "dns"
provisionerType: "template"
flavor: "dns"
excerpt: 'Prerequisites for `dns-in-codespace`:
- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.'
description: 'Outputs a *.localhost domain as the hostname and associated URL in http on port 80'
expectedOutputs:
- host
- url
hasMore: false

---

Prerequisites for `dns-in-codespace`:

- Have `gh` installed, this provisioner is using the GitHub CLI to get the name of the current GitHub Codespace.

{{% resource-provisioner-content description="Outputs a *.localhost domain as the hostname and associated URL in http on port 80" type="dns" expectedOutputs="host,url" %}}

{{% example-file filename="10-dns-with-url.provisioners.yaml" dir="resource-provisioners/community/dns/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "dotenv"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-compose"
resourceType: "environment"
provisionerType: "cmd"
flavor: "dotenv"
excerpt: 'Prerequisites:
- Have `python` installed, this provisioner is using Python to load the `.env` file.'
description: 'Loads environment variables from a local .env file.'
tool: dotenv
hasMore: false

---

Prerequisites:

- Have `python` installed, this provisioner is using Python to load the `.env` file.

{{% resource-provisioner-content description="Loads environment variables from a local .env file." type="environment" %}}

{{% example-file filename="10-env.provisioners.yaml" dir="resource-provisioners/community/environment/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "dotenv"
draft: false
mermaid: true
type: examples
source: "community"
implementation: "score-k8s"
resourceType: "environment"
provisionerType: "cmd"
flavor: "dotenv"
excerpt: 'Prerequisites:
- Have `python` installed, this provisioner is using Python to load the `.env` file.'
description: 'Loads environment variables from a local .env file.'
tool: dotenv
hasMore: false

---

Prerequisites:

- Have `python` installed, this provisioner is using Python to load the `.env` file.

{{% resource-provisioner-content description="Loads environment variables from a local .env file." type="environment" %}}

{{% example-file filename="10-env.provisioners.yaml" dir="resource-provisioners/community/environment/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
Loading