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.

Sign up for GitHub

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 metadata for collection releases #473

Closed
wants to merge 4 commits into from
+440 −68
Closed

Update metadata for collection releases #473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d97cef
Add `prefect-kubernetes` `v0.5.5` to block records
zzstoatzz Feb 24, 2025
30696dd
Update aggregate block metadata with `prefect-kubernetes` `v0.5.5`
zzstoatzz Feb 24, 2025
4505a6d
Add `prefect-kubernetes` `v0.5.5` to worker records
zzstoatzz Feb 24, 2025
fb016d2
Update aggregate worker metadata with `prefect-kubernetes` `v0.5.5`
zzstoatzz Feb 24, 2025
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
71 changes: 71 additions & 0 deletions collections/prefect-kubernetes/blocks/v0.5.5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"prefect-kubernetes": {
"block_types": {
"kubernetes-credentials": {
"name": "Kubernetes Credentials",
"slug": "kubernetes-credentials",
"logo_url": "https://cdn.sanity.io/images/3ugk85nk/production/2d0b896006ad463b49c28aaac14f31e00e32cfab-250x250.png",
"documentation_url": "https://prefecthq.github.io/prefect-kubernetes/credentials/#prefect_kubernetes.credentials.KubernetesCredentials",
"description": "Credentials block for generating configured Kubernetes API clients. This block is part of the prefect-kubernetes collection. Install prefect-kubernetes with `pip install prefect-kubernetes` to use this block.",
"code_example": "Load stored Kubernetes credentials:\n```python\nfrom prefect_kubernetes.credentials import KubernetesCredentials\n\nkubernetes_credentials = KubernetesCredentials.load(\"BLOCK_NAME\")\n```",
"block_schema": {
"checksum": "sha256:205323083b1cc3076ead5dc1bf6f6cd5f94d6644e54c05bcd0c9789c20915256",
"fields": {
"block_schema_references": {
"cluster_config": {
"block_schema_checksum": "sha256:90d421e948bfbe4cdc98b124995f0edd0f84b0837549ad1390423bad8e31cf3b",
"block_type_slug": "kubernetes-cluster-config"
}
},
"block_type_slug": "kubernetes-credentials",
"description": "Credentials block for generating configured Kubernetes API clients.",
"properties": {
"cluster_config": {
"anyOf": [
{
"$ref": "#/definitions/KubernetesClusterConfig"
},
{
"type": "null"
}
],
"default": null
}
},
"secret_fields": [],
"title": "KubernetesCredentials",
"type": "object",
"definitions": {
"KubernetesClusterConfig": {
"block_schema_references": {},
"block_type_slug": "kubernetes-cluster-config",
"description": "Stores configuration for interaction with Kubernetes clusters.\n\nSee `from_file` for creation.",
"properties": {
"config": {
"description": "The entire contents of a kubectl config file.",
"title": "Config",
"type": "object"
},
"context_name": {
"description": "The name of the kubectl context to use.",
"title": "Context Name",
"type": "string"
}
},
"required": [
"config",
"context_name"
],
"secret_fields": [],
"title": "KubernetesClusterConfig",
"type": "object"
}
}
},
"capabilities": [],
"version": "0.5.3"
}
}
}
}
}
233 changes: 233 additions & 0 deletions collections/prefect-kubernetes/workers/v0.5.5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
{
"prefect-kubernetes": {
"kubernetes": {
"default_base_job_configuration": {
"job_configuration": {
"command": "{{ command }}",
"env": "{{ env }}",
"labels": "{{ labels }}",
"name": "{{ name }}",
"namespace": "{{ namespace }}",
"job_manifest": {
"apiVersion": "batch/v1",
"kind": "Job",
"metadata": {
"generateName": "{{ name }}-",
"labels": "{{ labels }}",
"namespace": "{{ namespace }}"
},
"spec": {
"backoffLimit": 0,
"template": {
"spec": {
"completions": 1,
"containers": [
{
"args": "{{ command }}",
"env": "{{ env }}",
"image": "{{ image }}",
"imagePullPolicy": "{{ image_pull_policy }}",
"name": "prefect-job"
}
],
"parallelism": 1,
"restartPolicy": "Never",
"serviceAccountName": "{{ service_account_name }}"
}
},
"ttlSecondsAfterFinished": "{{ finished_job_ttl }}"
}
},
"cluster_config": "{{ cluster_config }}",
"job_watch_timeout_seconds": "{{ job_watch_timeout_seconds }}",
"pod_watch_timeout_seconds": "{{ pod_watch_timeout_seconds }}",
"stream_output": "{{ stream_output }}"
},
"variables": {
"description": "Default variables for the Kubernetes worker.\n\nThe schema for this class is used to populate the `variables` section of the default\nbase job template.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name given to infrastructure created by a worker.",
"title": "Name"
},
"env": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": "Environment variables to set when starting a flow run.",
"title": "Environment Variables",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels applied to infrastructure created by a worker.",
"title": "Labels",
"type": "object"
},
"command": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The command to use when starting a flow run. In most cases, this should be left blank and the command will be automatically generated by the worker.",
"title": "Command"
},
"namespace": {
"default": "default",
"description": "The Kubernetes namespace to create jobs within.",
"title": "Namespace",
"type": "string"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The image reference of a container image to use for created jobs. If not set, the latest Prefect image will be used.",
"examples": [
"docker.io/prefecthq/prefect:3-latest"
],
"title": "Image"
},
"service_account_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The Kubernetes service account to use for job creation.",
"title": "Service Account Name"
},
"image_pull_policy": {
"default": "IfNotPresent",
"description": "The Kubernetes image pull policy to use for job containers.",
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"title": "Image Pull Policy",
"type": "string"
},
"finished_job_ttl": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of seconds to retain jobs after completion. If set, finished jobs will be cleaned up by Kubernetes after the given delay. If not set, jobs will be retained indefinitely.",
"title": "Finished Job TTL"
},
"job_watch_timeout_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of seconds to wait for each event emitted by a job before timing out. If not set, the worker will wait for each event indefinitely.",
"title": "Job Watch Timeout Seconds"
},
"pod_watch_timeout_seconds": {
"default": 60,
"description": "Number of seconds to watch for pod creation before timing out.",
"title": "Pod Watch Timeout Seconds",
"type": "integer"
},
"stream_output": {
"default": true,
"description": "If set, output will be streamed from the job to local standard output.",
"title": "Stream Output",
"type": "boolean"
},
"cluster_config": {
"anyOf": [
{
"$ref": "#/definitions/KubernetesClusterConfig"
},
{
"type": "null"
}
],
"default": null,
"description": "The Kubernetes cluster config to use for job creation."
}
},
"type": "object",
"definitions": {
"KubernetesClusterConfig": {
"block_schema_references": {},
"block_type_slug": "kubernetes-cluster-config",
"description": "Stores configuration for interaction with Kubernetes clusters.\n\nSee `from_file` for creation.",
"properties": {
"config": {
"description": "The entire contents of a kubectl config file.",
"title": "Config",
"type": "object"
},
"context_name": {
"description": "The name of the kubectl context to use.",
"title": "Context Name",
"type": "string"
}
},
"required": [
"config",
"context_name"
],
"secret_fields": [],
"title": "KubernetesClusterConfig",
"type": "object"
}
}
}
},
"description": "Execute flow runs within jobs scheduled on a Kubernetes cluster. Requires a Kubernetes cluster.",
"display_name": "Kubernetes",
"documentation_url": "https://prefecthq.github.io/prefect-kubernetes/worker/",
"install_command": "pip install prefect-kubernetes",
"is_beta": false,
"logo_url": "https://cdn.sanity.io/images/3ugk85nk/production/2d0b896006ad463b49c28aaac14f31e00e32cfab-250x250.png",
"type": "kubernetes"
}
}
}
42 changes: 25 additions & 17 deletions views/aggregate-block-metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6649,53 +6649,61 @@
"description": "Credentials block for generating configured Kubernetes API clients. This block is part of the prefect-kubernetes collection. Install prefect-kubernetes with `pip install prefect-kubernetes` to use this block.",
"code_example": "Load stored Kubernetes credentials:\n```python\nfrom prefect_kubernetes.credentials import KubernetesCredentials\n\nkubernetes_credentials = KubernetesCredentials.load(\"BLOCK_NAME\")\n```",
"block_schema": {
"checksum": "sha256:957fa8dca90bd1b5fb9c575ee09e80b454116c0b134287fbc2eff47a72564c3b",
"checksum": "sha256:205323083b1cc3076ead5dc1bf6f6cd5f94d6644e54c05bcd0c9789c20915256",
"fields": {
"title": "KubernetesCredentials",
"description": "Credentials block for generating configured Kubernetes API clients.",
"type": "object",
"properties": {
"block_schema_references": {
"cluster_config": {
"$ref": "#/definitions/KubernetesClusterConfig"
"block_schema_checksum": "sha256:90d421e948bfbe4cdc98b124995f0edd0f84b0837549ad1390423bad8e31cf3b",
"block_type_slug": "kubernetes-cluster-config"
}
},
"block_type_slug": "kubernetes-credentials",
"secret_fields": [],
"block_schema_references": {
"description": "Credentials block for generating configured Kubernetes API clients.",
"properties": {
"cluster_config": {
"block_type_slug": "kubernetes-cluster-config",
"block_schema_checksum": "sha256:90d421e948bfbe4cdc98b124995f0edd0f84b0837549ad1390423bad8e31cf3b"
"anyOf": [
{
"$ref": "#/definitions/KubernetesClusterConfig"
},
{
"type": "null"
}
],
"default": null
}
},
"secret_fields": [],
"title": "KubernetesCredentials",
"type": "object",
"definitions": {
"KubernetesClusterConfig": {
"title": "KubernetesClusterConfig",
"block_schema_references": {},
"block_type_slug": "kubernetes-cluster-config",
"description": "Stores configuration for interaction with Kubernetes clusters.\n\nSee `from_file` for creation.",
"type": "object",
"properties": {
"config": {
"title": "Config",
"description": "The entire contents of a kubectl config file.",
"title": "Config",
"type": "object"
},
"context_name": {
"title": "Context Name",
"description": "The name of the kubectl context to use.",
"title": "Context Name",
"type": "string"
}
},
"required": [
"config",
"context_name"
],
"block_type_slug": "kubernetes-cluster-config",
"secret_fields": [],
"block_schema_references": {}
"title": "KubernetesClusterConfig",
"type": "object"
}
}
},
"capabilities": [],
"version": "0.3.7"
"version": "0.5.3"
}
}
}
Expand Down
Loading
Loading