Skip to content

Commit

Permalink
chore(nanocld): upgrade openapi definition and add Statefile reference
Browse files Browse the repository at this point in the history
  • Loading branch information
leon3s committed Sep 6, 2023
1 parent 11fc8a5 commit 0a9ac43
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 45 deletions.
29 changes: 29 additions & 0 deletions docs/references/nanocl/Statefile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Nanocl Statefile References
keywords: [documentation, references, nanocl, nanocld, Statefile, specification]
image: /img/logo.webp
sidebar_label: Statefile
sidebar_position: 5
---

import ApiSchema from '@theme/ApiSchema'

# Statefile

In Nanocl, a `Statefile` refers to a file that will containt the current state you want.<br />
It will help you manage your `Cargoes`, `Virtual Machines` and `Resources`.

## Metadata

The `Metadata` of the `Statefile` is always present usually at the top of the file:

<ApiSchema example={false} id="nanocld-latest" pointer="#/components/schemas/StateMeta" />

## Deployment


`Statefile` with a `Kind` set to `Deployment` can have the following keys:

<ApiSchema example={false} id="nanocld-latest" pointer="#/components/schemas/StateDeployment" />

If the kind is only set on `Cargo`, `Virtual Machine` or `Resource` only an array with the specific `Kind` will be allowed.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docs-next-hat-com",
"version": "0.9.1",
"version": "0.9.2",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down
Loading

0 comments on commit 0a9ac43

Please sign in to comment.