diff --git a/cloud/SUMMARY.md b/cloud/SUMMARY.md index 369daa4..a04da1d 100644 --- a/cloud/SUMMARY.md +++ b/cloud/SUMMARY.md @@ -5,7 +5,7 @@ * [Welcome to Spice.ai Cloud](README.md) * [Getting Started](getting-started/get-started/README.md) * [Sign in with GitHub](getting-started/get-started/portal-login.md) - * [Create a Spice app](getting-started/getting-started/portal-login-1.md) + * [Create a Spice project](getting-started/getting-started/portal-login-1.md) * [Add a Dataset and query data](getting-started/get-started/step-2-add-dataset-and-query-data.md) * [Add AI Model and chat with your data](getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md) * [Next Steps](getting-started/get-started/next-steps.md) @@ -20,7 +20,7 @@ * [Organizations](portal/organizations.md) * [Organization Secrets](portal/organization-secrets.md) * [OAuth Clients](portal/oauth-clients.md) -* [Apps](portal/apps/README.md) +* [Projects](portal/apps/README.md) * [API keys](portal/apps/api-keys.md) * [Secrets](portal/apps/secrets.md) * [Tags](portal/apps/tags.md) @@ -29,9 +29,9 @@ * [Transfer](portal/apps/transfer.md) * [Delete](portal/apps/delete.md) * [Runtime](portal/apps/runtime.md) -* [Public Apps](portal/public-apps.md) +* [Public Projects](portal/public-apps.md) * [SpiceRack Registry](portal/spicerack.md) -* [App Spicepod](portal/app-spicepod/README.md) +* [Project Spicepod](portal/app-spicepod/README.md) * [Spicepod Configuration](portal/app-spicepod/spicepod-configuration.md) * [Deployments](portal/app-spicepod/deployments.md) * [Spice Runtime Versions](portal/app-spicepod/spice-runtime-versions.md) diff --git a/cloud/getting-started/get-started/README.md b/cloud/getting-started/get-started/README.md index ea277d2..95caeea 100644 --- a/cloud/getting-started/get-started/README.md +++ b/cloud/getting-started/get-started/README.md @@ -11,7 +11,7 @@ description: Get started with the Spice.ai Cloud Platform in 5 mins. [portal-login.md](portal-login.md) {% endcontent-ref %} -### Create a Spice app +### Create a Spice project {% content-ref url="../getting-started/portal-login-1.md" %} [portal-login-1.md](../getting-started/portal-login-1.md) diff --git a/cloud/getting-started/get-started/next-steps.md b/cloud/getting-started/get-started/next-steps.md index 14cdcfd..7c7c406 100644 --- a/cloud/getting-started/get-started/next-steps.md +++ b/cloud/getting-started/get-started/next-steps.md @@ -2,5 +2,5 @@ Learn more about building AI applications and agents with the Spice.ai Cloud Platform. -
PlaygroundStart experimenting in the Playgroundhttps://spice.ai/login
FeaturesExplore the features of the platformapps
Use-CasesExplore use-cases for Spice.ai.Broken link
+
PlaygroundStart experimenting in the Playgroundhttps://spice.ai/login
FeaturesExplore the features of the platformprojects
Use-CasesExplore use-cases for Spice.ai.Broken link
diff --git a/cloud/getting-started/get-started/step-2-add-dataset-and-query-data.md b/cloud/getting-started/get-started/step-2-add-dataset-and-query-data.md index 3647aec..e26f452 100644 --- a/cloud/getting-started/get-started/step-2-add-dataset-and-query-data.md +++ b/cloud/getting-started/get-started/step-2-add-dataset-and-query-data.md @@ -5,7 +5,7 @@ icon: circle-3 # Add a Dataset and query data -To add a dataset to the Spice app, navigate to **Build** > [**Code**](../../portal/app-spicepod/). +To add a dataset to the Spice project, navigate to **Build** > [**Code**](../../portal/app-spicepod/). Use the **Components sidebar** on the right to select from available **Data Connectors**, **Model Providers**, and ready-to-use **Datasets**. @@ -20,7 +20,7 @@ Use the **Components sidebar** on the right to select from available **Data Conn ### \[Optional] Execute a SQL query using cURL -6. Go app **Settings** and copy one of the app API Keys. +6. Go to project **Settings** and copy one of the project API Keys. 7. Replace `[API-KEY]` in the sample below with your API Key and execute from a terminal. {% tabs %} diff --git a/cloud/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md b/cloud/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md index 56f9dc6..3cd46e2 100644 --- a/cloud/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md +++ b/cloud/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md @@ -50,7 +50,7 @@ models: ### \[Optional] Call chat completions API using cURL -10. Replace `[API-KEY]` in the sample below with the app API Key and execute in a terminal. +10. Replace `[API-KEY]` in the sample below with the project API Key and execute in a terminal. {% tabs %} {% tab title="cURL" %} diff --git a/cloud/getting-started/getting-started/portal-login-1.md b/cloud/getting-started/getting-started/portal-login-1.md index b3e9467..cc7e39a 100644 --- a/cloud/getting-started/getting-started/portal-login-1.md +++ b/cloud/getting-started/getting-started/portal-login-1.md @@ -1,21 +1,21 @@ --- -description: Create your first Spice app +description: Create your first Spice project icon: circle-2 --- -# Create a Spice app +# Create a Spice project -Once [signed in with GitHub](../get-started/portal-login.md), you will be redirected to the **new application page.** Set a name, add a model provider, and optionally select one of ready to use datasets. +Once [signed in with GitHub](../get-started/portal-login.md), you will be redirected to the **new project page.** Set a name, add a model provider, and optionally select one of ready to use datasets. -1. Enter a name for the application. +1. Enter a name for the project. 2. Select region. -3. Click **Create application**. +3. Click **Create project**. - It will take up to 30 seconds to create and provision a dedicated Spice.ai instance for the application. -4. Once the application instance is deployed and ready, you will be redirected to the [Playground](../../portal/playground/). -5. Executing the `show tables` SQL query will show the default datasets available for the app. + It will take up to 30 seconds to create and provision a dedicated Spice.ai instance for the project. +4. Once the project instance is deployed and ready, you will be redirected to the [Playground](../../portal/playground/). +5. Executing the `show tables` SQL query will show the default datasets available for the project. -🎉 **Congrats, you've created your first** [**Spice app**](../../portal/apps/)**!** +🎉 **Congrats, you've created your first** [**Spice project**](../../portal/apps/)**!** Continue to [Step. 3 to add a dataset and query it](../get-started/step-2-add-dataset-and-query-data.md). diff --git a/cloud/portal/app-spicepod/README.md b/cloud/portal/app-spicepod/README.md index c0f860f..e1d8788 100644 --- a/cloud/portal/app-spicepod/README.md +++ b/cloud/portal/app-spicepod/README.md @@ -2,9 +2,9 @@ icon: cube --- -# App Spicepod +# Project Spicepod -Every Spice app is powered by a managed instance of the [Spice OSS Runtime](https://www.spiceai.org/) deployed to the platform. +Every Spice project is powered by a managed instance of the [Spice OSS Runtime](https://www.spiceai.org/) deployed to the platform. A **Spicepod** is a package that encapsulates application-centric datasets and machine learning (ML) models. diff --git a/cloud/portal/app-spicepod/deployments.md b/cloud/portal/app-spicepod/deployments.md index b7b6be2..e815387 100644 --- a/cloud/portal/app-spicepod/deployments.md +++ b/cloud/portal/app-spicepod/deployments.md @@ -1,5 +1,5 @@ --- -description: Monitor and manage app Spicepod instances and deployments. +description: Monitor and manage project Spicepod instances and deployments. icon: rocket-launch --- @@ -23,7 +23,7 @@ Each deployment listed on the **Deployments** tab reports a status derived from | **Unhealthy** | All required replicas are ready, but at least one is failing its health check. | | **Terminating** | The deployment is being replaced by a newer deployment that is ready to take traffic. | | **Succeeded** | The deployment completed and its instances are no longer reporting live state. | -| **Paused** | The app is paused, so no deployment is serving. | +| **Paused** | The project is paused, so no deployment is serving. | | **Created** | No live state is available for the deployment, typically because it has already been replaced. | | **Failed** | The deployment failed. | @@ -35,15 +35,15 @@ When a deployed Spicepod reports errors or warnings, the portal collects them in Issues are surfaced in four places: -* A banner on every page of the app, listing the most recent error and the number of other errors. The banner covers errors only — warnings appear in the **Issues** panel. -* An error count on the **Deployments** tab in the app navigation. +* A banner on every page of the project, listing the most recent error and the number of other errors. The banner covers errors only — warnings appear in the **Issues** panel. +* An error count on the **Deployments** tab in the project navigation. * An **Issues** panel on the **Deployments** page, and on each instance page scoped to that instance. Each panel lists up to five issues and links to the full list. -* A dedicated **Issues** page for the app, listing every issue without a limit. +* A dedicated **Issues** page for the project, listing every issue without a limit. * An indicator on the affected row in **Datasets** and **Models**, when an issue can be attributed to a component. The feed combines runtime `ERROR` and `WARN` log lines with the reported status of each dataset. Repeats of the same failure collapse into one row with an occurrence count, so a connector retrying every second appears once rather than hundreds of times. -Issues are ordered errors first, then by how often they occurred, then by how recently. A panel capped at five rows therefore shows the errors before any warning, and the panel header keeps the full error and warning counts for the app or instance. **View all** *N* **issues** in the panel footer opens the dedicated **Issues** page, which lists the entire set. +Issues are ordered errors first, then by how often they occurred, then by how recently. A panel capped at five rows therefore shows the errors before any warning, and the panel header keeps the full error and warning counts for the project or instance. **View all** *N* **issues** in the panel footer opens the dedicated **Issues** page, which lists the entire set. Each row shows where the issue came from, how many times it occurred, when it was last seen, the dataset or model it was attributed to, and the instance that reported it. **Show details** expands the full text, including stack traces. The link on the row opens the originating instance's logs filtered to the issue, or the component's page for an issue reported by a dataset. @@ -51,16 +51,16 @@ Each row shows where the issue came from, how many times it occurred, when it wa Dismissing an error hides that specific error. A different failure raises the banner again. {% endhint %} -An app with no issues shows no banner, no count, and no panel. The dedicated **Issues** page remains reachable and reports that no issues were detected. +A project with no issues shows no banner, no count, and no panel. The dedicated **Issues** page remains reachable and reports that no issues were detected. #### Get AI help -Each issue row has a **Get AI help** action that analyzes that issue on demand. The analysis reads the app's recent runtime logs and returns a likely root cause, a short numbered list of fix steps, links to the relevant documentation, and a confidence level. +Each issue row has a **Get AI help** action that analyzes that issue on demand. The analysis reads the project's recent runtime logs and returns a likely root cause, a short numbered list of fix steps, links to the relevant documentation, and a confidence level. Results are generated per issue and are not produced until the action is used. {% hint style="warning" %} -An AI analysis is a suggestion, not a diagnosis. Verify each step against the app's own configuration before applying it. +An AI analysis is a suggestion, not a diagnosis. Verify each step against the project's own configuration before applying it. {% endhint %} ### Spicepod Instance Logs diff --git a/cloud/portal/app-spicepod/spice-runtime-versions.md b/cloud/portal/app-spicepod/spice-runtime-versions.md index 0675f79..cf1b75a 100644 --- a/cloud/portal/app-spicepod/spice-runtime-versions.md +++ b/cloud/portal/app-spicepod/spice-runtime-versions.md @@ -4,10 +4,10 @@ icon: gear # Spice Runtime Versions -Each new app deployment automatically retrieves the most recent stable Spice OSS release. Visit the [Releases page](https://github.com/spiceai/spiceai/releases) or [Spice OSS blog](https://spiceai.org/blog) to check for the latest runtime updates. +Each new project deployment automatically retrieves the most recent stable Spice OSS release. Visit the [Releases page](https://github.com/spiceai/spiceai/releases) or [Spice OSS blog](https://spiceai.org/blog) to check for the latest runtime updates. -### Migrate Exiting Apps +### Migrate Existing Projects -All Spice Apps are now powered by the latest, next-generation Spice.ai Open Source data and AI engine. Existing apps have been migrated but require a manual setup step to connect datasets and/or model providers. +All Spice projects are now powered by the latest Spice.ai Open Source data and AI engine. Existing projects have been migrated but require a manual setup step to connect datasets and/or model providers. Learn More: Read the [Announcing 1.0-stable](https://spiceai.org/blog/announcing-1.0-stable) blog post for details on this upgrade, and visit the [Spice.ai Cookbook](https://spiceai.org/cookbook) for over 50 quickstarts and examples. diff --git a/cloud/portal/app-spicepod/spicepod-configuration.md b/cloud/portal/app-spicepod/spicepod-configuration.md index 53ef25f..04c0fe6 100644 --- a/cloud/portal/app-spicepod/spicepod-configuration.md +++ b/cloud/portal/app-spicepod/spicepod-configuration.md @@ -4,15 +4,15 @@ icon: square-code # Spicepod Configuration -### Edit app spicepod not connected to GitHub +### Edit project spicepod not connected to GitHub -To update Spice App spicepod.yaml, navigate to **Build** > **Code**. Use Components sidebar to add data connectors, model providers and preconfigured datasets, or manually edit spicepod.yaml in code editor. +To update the Spice project spicepod.yaml, navigate to **Build** > **Code**. Use Components sidebar to add data connectors, model providers and preconfigured datasets, or manually edit spicepod.yaml in code editor. After saving the spicepod changes, a new deployment must be triggered. Learn more about [Spicepod Deployments](deployments.md). -### Edit app spicepod connected to GitHub +### Edit project spicepod connected to GitHub -If the Spice App is connected to a GitHub repository ([learn more](../apps/connect-github.md) about how to connect), the only way to update the Spicepod configuration is to edit the spicepod.yaml file in the root of your repository and push it to the default branch. +If the Spice project is connected to a GitHub repository ([learn more](../apps/connect-github.md) about how to connect), the only way to update the Spicepod configuration is to edit the spicepod.yaml file in the root of your repository and push it to the default branch. To apply the updated spicepod, a new deployment must be triggered. Learn more about [Spicepod Deployments](deployments.md). diff --git a/cloud/portal/apps/README.md b/cloud/portal/apps/README.md index 77f8d7d..01df704 100644 --- a/cloud/portal/apps/README.md +++ b/cloud/portal/apps/README.md @@ -2,15 +2,19 @@ icon: cubes --- -# Apps +# Projects -**Apps** are self-contained instances of Spice OSS Runtime, running in Spice.ai Cloud Platform. +**Projects** are self-contained instances of Spice OSS Runtime, running in Spice.ai Cloud Platform. -Each app has a unique API Key and owned by individual accounts or [**organizations**](../organizations.md). +Each project has a unique API Key and owned by individual accounts or [**organizations**](../organizations.md). + +{% hint style="info" %} +Projects were previously called apps. The portal now uses **Project** throughout, and the Management API serves canonical `/v1/projects` routes alongside the supported legacy `/v1/apps` paths. See [Management APIs](../../api/management/). +{% endhint %} ### Learn how to: -* [Transfer an app to another organization](transfer.md) -* [Connect an app with your existing GitHub repository](connect-github.md) -* [Delete an app](delete.md) +* [Transfer a project to another organization](transfer.md) +* [Connect a project with your existing GitHub repository](connect-github.md) +* [Delete a project](delete.md) * [Create and toggle custom Dataset and Views](../datasets-and-views.md) diff --git a/cloud/portal/apps/api-keys.md b/cloud/portal/apps/api-keys.md index ac9859d..07716dd 100644 --- a/cloud/portal/apps/api-keys.md +++ b/cloud/portal/apps/api-keys.md @@ -4,12 +4,12 @@ icon: key # API keys -Each Spice app has two pre-generated API keys, which can be used with [Spice SDKs](../../../sdks/), the [HTTP API](../../api/sql-query/http-api.md) or the [Apache Arrow Flight API](../../api/sql-query/apache-arrow-flight-api.md). +Each Spice project has two pre-generated API keys, which can be used with [Spice SDKs](../../../sdks/), the [HTTP API](../../api/sql-query/http-api.md) or the [Apache Arrow Flight API](../../api/sql-query/apache-arrow-flight-api.md). ## View API Keys -1. Navigate to your Spice app in the [portal](https://spice.ai). -2. Click **Settings** in the app navigation sidebar. +1. Navigate to your Spice project in the [portal](https://spice.ai). +2. Click **Settings** in the project navigation sidebar. 3. Under the **General** section, locate the **API Key 1** and **API Key 2** fields. 4. Click on an API key field to copy its value to your clipboard. @@ -17,10 +17,11 @@ Each Spice app has two pre-generated API keys, which can be used with [Spice SDK If an API key has been compromised or you need to rotate keys, you can regenerate individual keys. Regenerating a key **immediately invalidates** the previous key. -1. Navigate to your Spice app and click **Settings** -> **General**. -2. Click the **Regenerate** button next to the API key you want to rotate (**API Key 1** or **API Key 2**). -3. Confirm the regeneration when prompted. -4. Copy the new key and update it in your applications. +1. Navigate to your Spice project and click **Settings**. +2. Scroll to the **Danger Zone** section. +3. Click the **Regenerate key** button next to the key you want to rotate (**Regenerate API Key 1** or **Regenerate API Key 2**). +4. Confirm the regeneration when prompted. +5. Copy the new key and update it in your applications. {% hint style="warning" %} Regenerating an API key immediately invalidates the old key. Any applications using the old key will lose access. Use the two-key system to rotate keys without downtime: update your applications to use the secondary key first, then regenerate the primary key. diff --git a/cloud/portal/apps/connect-github.md b/cloud/portal/apps/connect-github.md index 48ae346..9500b10 100644 --- a/cloud/portal/apps/connect-github.md +++ b/cloud/portal/apps/connect-github.md @@ -1,5 +1,5 @@ --- -description: Connect your Spice.ai app to a GitHub repository +description: Connect your Spice.ai project to a GitHub repository icon: link-simple --- @@ -10,22 +10,24 @@ icon: link-simple Before connecting: * **Admin access**: Ensure you have administrative access to the GitHub repository. This level of access is required to [install the Spice.ai GitHub app](https://docs.github.com/en/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations#requirements-to-install-a-github-app-on-an-organization). -* **Matching repository name**: The Spice.ai app and the GitHub repository names **must match**. For example: - * **Spice.ai app**: [spice.ai/spiceai/demo](https://spice.ai/spiceai/demo) +* **Matching repository name**: The Spice.ai project and the GitHub repository names **must match**. For example: + * **Spice.ai project**: [spice.ai/spiceai/demo](https://spice.ai/spiceai/demo) * **GitHub repository**: [github.com/spiceai/demo](https://github.com/spiceai/demo) To quickly set up a new repository, use the [spiceai/spicepod-template](https://github.com/spiceai/spicepod-template) as a starting point: {% hint style="warning" %} -Make sure to copy app spicepod.yaml contents from **Build** > **Code** and place it in the root of the repository before linking. +Make sure to copy the project spicepod.yaml contents from **Build** > **Code** and place it in the root of the repository before linking. {% endhint %} ## Connect 1. Ensure the repository is set up as per instructions above. -2. In the context of the Spice app to connect, navigate to **Settings,** then click the **Connect repository** button. +2. In the context of the Spice project to connect, navigate to **Settings**, then find the **Connect Git Repository** section. 3. Follow GitHub App installation instructions. > Ensure that you select all repositories or specifically the repository you intend to connect. -3. Finally, link the repository to your Spice.ai app. +4. Finally, link the repository to your Spice.ai project. + +Once connected, the section is titled **Connected Git Repository** and offers a **Production Branch** selector and a **Disconnect** button. diff --git a/cloud/portal/apps/delete.md b/cloud/portal/apps/delete.md index 419c558..0ba1adb 100644 --- a/cloud/portal/apps/delete.md +++ b/cloud/portal/apps/delete.md @@ -2,27 +2,27 @@ icon: trash --- -# Delete App +# Delete Project -You can permanently delete a Spice app from the portal. Deleting an app will stop all running deployments and release its associated resources. +You can permanently delete a Spice project from the portal. Deleting a project will stop all running deployments and release its associated resources. {% hint style="danger" %} -Deleting an app is **permanent** and cannot be undone. All associated deployments, datasets, and configurations will be removed. +Deleting a project is **permanent** and cannot be undone. All associated deployments, datasets, and configurations will be removed. {% endhint %} -## Delete an App +## Delete a project -1. Navigate to the app you want to delete. -2. Click **Settings** in the app navigation sidebar. +1. Navigate to the project you want to delete. +2. Click **Settings** in the project navigation sidebar. 3. Scroll down to the **Danger Zone** section. -4. Click the **Delete app** button. -5. Type the full app name to confirm deletion. -6. Click **Delete Application** to permanently delete the app. +4. Click the **Delete project** button. +5. In the **Delete Project** dialog, type `/` to confirm deletion. +6. Click **Delete** to permanently delete the project. {% hint style="info" %} -Only app owners and organization admins can delete apps. +Only project owners and organization admins can delete projects. {% endhint %} ## Delete via API -Apps can also be deleted programmatically. See the [Apps Management API](../../api/management/apps.md#delete-app) for details. +Projects can also be deleted programmatically. See the [Management APIs](../../api/management/) reference for details. diff --git a/cloud/portal/apps/publish.md b/cloud/portal/apps/publish.md index 91bc20f..5af68a4 100644 --- a/cloud/portal/apps/publish.md +++ b/cloud/portal/apps/publish.md @@ -4,23 +4,30 @@ icon: eye # Publish -Publishing an app controls its visibility to other users on the Spice.ai platform. +Publishing a project controls its visibility to other users on the Spice.ai platform. -## App Visibility +## Project visibility -Apps can be set to one of two visibility levels: +Projects can be set to one of two visibility levels: -- **Private** (default): Only organization members can view and access the app. -- **Public**: The app is visible to all Spice.ai users. Public apps can be discovered, queried, and used as data sources by others via the `spice connect` or `spice add` commands. +- **Private** (default): Only organization members can view and access the project. +- **Public**: The project is visible to all Spice.ai users. Public projects can be discovered, queried, and used as data sources by others via the `spice connect` or `spice add` commands. -## Changing Visibility +## Before publishing -1. Select your app. -2. Navigate to **Settings** and scroll to the **App visibility** section. -3. Toggle between **Private** and **Public**. +A project must be connected to a **public** GitHub repository before it can be published. SpiceRack uses the repository to show the Spicepod configuration behind the public listing. See [Connect GitHub](connect-github.md). + +Viewers cannot change project visibility. + +## Changing visibility + +1. Select your project. +2. Navigate to **Settings** and scroll to the **Project visibility** section. +3. Click **Publish project** to make it public, or **Make private** to unpublish it. +4. Confirm in the dialog. {% hint style="warning" %} -Making an app public exposes its datasets and models to all Spice.ai users. Ensure no sensitive data is accessible before publishing. +Making a project public exposes its datasets and models to all Spice.ai users. Ensure no sensitive data is accessible before publishing. {% endhint %} -Learn more about [public apps](../public-apps.md). +Learn more about [public projects](../public-apps.md). diff --git a/cloud/portal/apps/runtime.md b/cloud/portal/apps/runtime.md index 851c8ec..5e80df2 100644 --- a/cloud/portal/apps/runtime.md +++ b/cloud/portal/apps/runtime.md @@ -1,21 +1,21 @@ --- -description: Configuring Spice.ai runtime for your Spice application +description: Configuring Spice.ai runtime for your Spice project icon: gear --- # Runtime -Navigate to `Settings` -> `Runtime` to configure the runtime settings for your Spice application. +Navigate to `Settings` -> `Runtime` to configure the runtime settings for your Spice project. ### Runtime Version -The runtime version determines the Spice.ai Open Source version for your Spice application. Each new deployment automatically adopts the latest stable version of the Spice runtime to ensure access to the most recent features and optimizations. +The runtime version determines the Spice.ai Open Source version for your Spice project. Each new deployment automatically adopts the latest stable version of the Spice runtime to ensure access to the most recent features and optimizations. ### Runtime Region -The runtime region specifies the geographic location of the data center hosting your Spice application. Region selection optimizes latency, compliance, and performance based on your business needs. +The runtime region specifies the geographic location of the data center hosting your Spice project. Region selection optimizes latency, compliance, and performance based on your business needs. -* **Availability**: The region is selected when the app is created. Changing the region of an existing app is available to Enterprise plan customers — contact support to request the change. +* **Availability**: The region is selected when the project is created. Changing the region of an existing project is available to Enterprise plan customers — contact support to request the change. * **Supported Regions**: * **North America**: * **US East (N. Virginia)** - `us-east-1` (AWS) @@ -23,7 +23,7 @@ The runtime region specifies the geographic location of the data center hosting ### Compute -Compute settings define the resource allocation for your Spice application, balancing performance and cost. +Compute settings define the resource allocation for your Spice project, balancing performance and cost. **Standard Compute Instances**: diff --git a/cloud/portal/apps/secrets.md b/cloud/portal/apps/secrets.md index d50b1b0..3e1b5c2 100644 --- a/cloud/portal/apps/secrets.md +++ b/cloud/portal/apps/secrets.md @@ -4,7 +4,7 @@ icon: lock # Secrets -App Secrets are key-value pairs that are passed to the Spice Runtime instance as environment secrets. Secrets are securely encrypted and accessible only through the app in which they were created. To share one secret across several apps, use an [organization secret](../organization-secrets.md) instead. +Project Secrets are key-value pairs that are passed to the Spice Runtime instance as environment secrets. Secrets are securely encrypted and accessible only through the project in which they were created. To share one secret across several projects, use an [organization secret](../organization-secrets.md) instead. Once a secret is saved, its value cannot be retrieved through Spice Cloud. Editing a secret replaces its value; the name cannot be changed. @@ -12,7 +12,7 @@ The **Secrets** section is available to organization owners, admins, and members ### Create a new secret -1. Select your app. +1. Select your project. 2. Navigate to **Settings** tab and select **Secrets** section. 3. Fill **Secret Name** and **Secret Value** fields and click **Add**. 4. Saved secrets can be referenced in the Spicepod configuration as\ @@ -32,6 +32,6 @@ Secret names must start with a letter or an underscore and may contain only lett ### Linked Organization Secrets -Secrets defined for the organization are listed under **Linked Organization Secrets**. Only the secrets selected and saved here are available to the app at runtime and in secret pickers. When an app secret and a linked organization secret have the same name, the app secret takes precedence. +Secrets defined for the organization are listed under **Linked Organization Secrets**. Only the secrets selected and saved here are available to the project at runtime and in secret pickers. When a project secret and a linked organization secret have the same name, the project secret takes precedence. [Learn more about organization secrets.](../organization-secrets.md) diff --git a/cloud/portal/apps/tags.md b/cloud/portal/apps/tags.md index d372436..79b49fe 100644 --- a/cloud/portal/apps/tags.md +++ b/cloud/portal/apps/tags.md @@ -4,22 +4,26 @@ icon: tags # Tags -Tags are key-value pairs that help you organize and categorize your Spice apps. Use tags to label apps by environment, team, purpose, or any other dimension meaningful to your organization. +Tags are key-value pairs that help you organize and categorize your Spice projects. Use tags to label projects by environment, team, purpose, or any other dimension meaningful to your organization. ## Managing Tags -1. Select your app. +1. Select your project. 2. Navigate to **Settings** and select **Tags**. -3. Enter a **Key** and **Value** for the new tag, then click **Save**. +3. Enter a **Key** and **Value** for the new tag, then click **Save Tags** and confirm the change. -Tags are immediately associated with the app and visible to all organization members. +Tags are immediately associated with the project and visible to all organization members. + +{% hint style="info" %} +A small set of tag keys is reserved and managed by the platform. Reserved keys are hidden from the tags editor and cannot be added or removed there. +{% endhint %} ### Tag Limits Tag availability depends on your plan: - **Community**: Tags are not available. -- **Pro and Enterprise**: Unlimited tags per app. +- **Pro and Enterprise**: Unlimited tags per project. ### Use Cases @@ -28,4 +32,4 @@ Tags are useful for: - **Environment labeling**: e.g. `env: production`, `env: staging` - **Team ownership**: e.g. `team: data-engineering` - **Cost tracking**: e.g. `cost-center: analytics` -- **Filtering and searching**: Quickly find apps by tag in the portal. +- **Filtering and searching**: Quickly find projects by tag in the portal. diff --git a/cloud/portal/apps/transfer.md b/cloud/portal/apps/transfer.md index 8292334..4ba5a8d 100644 --- a/cloud/portal/apps/transfer.md +++ b/cloud/portal/apps/transfer.md @@ -4,19 +4,24 @@ icon: arrow-right-from-arc # Transfer -You can transfer an App's ownership to another [**organization**](/broken/pages/05CWejAJRFHeBbS9KyeQ)**.** +You can transfer a project's ownership to another [**organization**](../organizations.md)**.** {% hint style="info" %} -App transfer is currently limited to organizations you have access to. +Project transfer is currently limited to organizations you have access to, and requires organization admin permissions. {% endhint %} Learn more about [**organization management**](../organizations.md). -## Transfer an App +## Transfer a project -1. To transfer an app, click **Settings** in the app navigation. -2. In the **Danger Zone** section of **App Settings**, click the **Transfer app** button. -3. On the **Transfer application** page, select the **New owner** organization from the menu. -4. Type the full app name into the text box to confirm and click **Transfer Application** to complete process. +1. To transfer a project, click **Settings** in the project navigation. +2. In the **Danger Zone** section, click the **Transfer project** button. +3. On the **Transfer project** page, select the **New owner** organization from the menu. +4. Type `/` into the text box to confirm. +5. Click **Transfer & redeploy project** to complete the process. -The App will now be accessible by the receiving organization and its members. +The project will now be accessible by the receiving organization and its members. + +{% hint style="info" %} +A project connected to a GitHub repository cannot be transferred. Disconnect the repository first — see [Connect GitHub](connect-github.md). +{% endhint %} diff --git a/cloud/portal/public-apps.md b/cloud/portal/public-apps.md index aba76ac..229c116 100644 --- a/cloud/portal/public-apps.md +++ b/cloud/portal/public-apps.md @@ -1,40 +1,40 @@ --- -description: Publish app to https://spicerack.org +description: Publish a project to https://spicerack.org icon: globe --- -# Public Apps +# Public Projects -Public Spice Apps can be forked, added as a dependency or connected to using Spice OSS Spice.ai connector. +Public Spice projects can be forked, added as a dependency or connected to using Spice OSS Spice.ai connector. -### Making the app public +### Making the project public {% hint style="info" %} -The app must be connected to a public GitHub repository to be made public.\ -Check out how to connect app to the repository - [connect GitHub](apps/connect-github.md). +The project must be connected to a public GitHub repository to be made public.\ +Check out how to connect a project to the repository - [connect GitHub](apps/connect-github.md). {% endhint %} -To make your app public, go to your app settings and click **Make public**. +To make your project public, go to your project settings, click **Publish project** in the **Project visibility** section, then confirm with **Make public**. -After that, the app will be visible to all users at `https://spice.ai//` and searchable at [https://spicerack.org](https://spicerack.org). +After that, the project will be visible to all users at `https://spice.ai//` and searchable at [https://spicerack.org](https://spicerack.org). ### On the registry -A public app is indexed on [SpiceRack](https://spicerack.org), the package registry for Spicepods. Its package page sits at `https://spicerack.org//` and lists the datasets, models, and dependencies declared in the app's Spicepod manifest. +A public project is indexed on [SpiceRack](https://spicerack.org), the package registry for Spicepods. Its package page sits at `https://spicerack.org//` and lists the datasets, models, and dependencies declared in the project's Spicepod manifest. Other users install the published Spicepod in one of three ways: ```bash -spice add / +spice add / ``` ```bash -spice connect / +spice connect / ``` ```yaml dependencies: - - / + - / ``` See [SpiceRack Registry](spicerack.md) for browsing, search, and the registry API. diff --git a/cloud/portal/spicerack.md b/cloud/portal/spicerack.md index 1991d38..a8f918b 100644 --- a/cloud/portal/spicerack.md +++ b/cloud/portal/spicerack.md @@ -7,7 +7,7 @@ icon: boxes-stacked [SpiceRack](https://spicerack.org) is the public package registry for Spicepods. It indexes the datasets, models, and AI apps that publishers have made public, and every package installs into any Spice runtime. -Browsing and installing require no account. Publishing requires a public Spice app — see [Public Apps](public-apps.md). +Browsing and installing require no account. Publishing requires a public Spice project — see [Public Projects](public-apps.md). ## Browse and search @@ -71,4 +71,4 @@ The full reference, including per-parameter defaults, is published at [https://s ## Publish a package -Make a Spice app public and it is indexed on SpiceRack. See [Public Apps](public-apps.md) for the prerequisites and the steps. +Make a Spice project public and it is indexed on SpiceRack. See [Public Projects](public-apps.md) for the prerequisites and the steps.