Skip to content

Commit

Permalink
Spicepod v0.2 specification.
Browse files Browse the repository at this point in the history
  • Loading branch information
lukekim committed Nov 23, 2023
1 parent 785bb17 commit 1519613
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2023 Spice AI, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
---
type: docs
title: "Manifest syntax for Spice.ai Pods"
linkTitle: "Pod specification"
title: 'Manifest syntax for Spicepods'
linkTitle: 'Spicepod specification'
weight: 60
description: "Detailed documentation on the Spice.ai Pod manifest syntax"
description: 'Detailed documentation on the Spicepod manifest syntax'
---

## About YAML syntax for pod manifests
## About YAML syntax for Spicepod manifests

Pod manifests use YAML syntax, and must end in a `.yaml` file extension. If you're new to YAML and want to learn more, see "[Learn YAML in Y minutes](https://learnxinyminutes.com/docs/yaml/)."
Spicepod manifests use YAML syntax and must end in a `.yaml` or `.yml` file extension. If you're new to YAML and want to learn more, see "[Learn YAML in Y minutes](https://learnxinyminutes.com/docs/yaml/)."

You must store pod manifest files in the `spicepods` directory of your application code. It is not required for the `spicepods` directory to be located at the root of your code repository.
Spicepod manifest files are stored in the root directory of your application code.

## `name`

The name of your pod. Spice.ai uses the name of your pod when rendering the dashboard and as the key for the API requests. If you omit `name`, Spice.ai sets it to the name of the YAML file excluding the `.yaml` extension.
The name of the Spicepod.

If `name` is omitted, it is set to the name of the YAML file excluding the extension.

## `params`

An optional `map` of parameters that you can specify to tune how Spice.ai interacts with your pod. The following parameters are available:
An optional `map` of parameters.

The following parameters are currently supported:

| Parameter | Default |
| ------------------------------------------- | ---------------- |
Expand Down

0 comments on commit 1519613

Please sign in to comment.