> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/references/resources/service/field-reference.md).

# Field reference

Reference for Service manifest fields and nested runtime configuration.

Use this page to look up Service manifest fields, required values, and nested options.

## Top-level fields

| Field         | Description                                | Required |
| ------------- | ------------------------------------------ | -------- |
| `version`     | Manifest version. Use `v2alpha`.           | Yes      |
| `name`        | Service Resource name.                     | Yes      |
| `type`        | Resource type. Use `service`.              | Yes      |
| `tags`        | Labels for grouping and discovery.         | No       |
| `description` | Human-readable description of the Service. | No       |
| `spec`        | Service runtime specification.             | Yes      |

## `spec` fields

| Field                               | Description                                                                                                                                                                                                                                             | Required |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `spec.hostname`                     | Hostname assigned to the Service.                                                                                                                                                                                                                       | No       |
| `spec.compute`                      | Compute Resource used to run the Service.                                                                                                                                                                                                               | Yes      |
| `spec.highAvailabilityConfig`       | Spreads Service replicas across hostnames, zones, or regions for resiliency.                                                                                                                                                                            | No       |
| `spec.highAvailabilityConfig.mode`  | `mode: preferred` spreads replicas across that boundary where possible, but still schedules them together if enough distinct options aren't available. `mode: required` only schedules if the separation can be fully met, otherwise the Service fails. | No       |
| `spec.highAvailabilityConfig.level` | `level` sets how far replicas spread apart: `hostname` keeps copies on separate machines, `zone` keeps them in separate data centers within the same region, and `region` keeps them in entirely separate geographic locations.                         | No       |
| `spec.stateful`                     | Enables stateful runtime behavior. Required for inline Service storage.                                                                                                                                                                                 | No       |
| `spec.replicas`                     | Number of Service replicas to maintain.                                                                                                                                                                                                                 | No       |
| `spec.servicePorts`                 | List of exposed Service ports.                                                                                                                                                                                                                          | No       |
| `spec.resources.requests`           | CPU and memory requested for the Service runtime.                                                                                                                                                                                                       | No       |
| `spec.resources.limits`             | CPU and memory limits for the Service runtime.                                                                                                                                                                                                          | No       |
| `spec.disk`                         | Inline disk mounted into the Service.                                                                                                                                                                                                                   | No       |
| `spec.use.volumes`                  | Existing Volume mounts consumed by the Service.                                                                                                                                                                                                         | No       |
| `spec.use.projection`               | Projects Secrets, environment variables, and files into the runtime.                                                                                                                                                                                    | No       |
| `spec.stack`                        | Runtime stack used by the Service, such as `container`.                                                                                                                                                                                                 | Yes      |
| `spec.stackSpec`                    | Stack-specific runtime configuration.                                                                                                                                                                                                                   | Yes      |

## `spec.servicePorts[]` fields

| Field                      | Description                          | Required                         |
| -------------------------- | ------------------------------------ | -------------------------------- |
| `spec.servicePorts[].name` | Logical name for the exposed port.   | Yes, when `servicePorts` is used |
| `spec.servicePorts[].port` | Numeric port exposed by the Service. | Yes, when `servicePorts` is used |

## `spec.disk` fields

| Field                 | Description                                      | Required                 |
| --------------------- | ------------------------------------------------ | ------------------------ |
| `spec.disk.size`      | Requested inline disk size, such as `10Gi`.      | Yes, when `disk` is used |
| `spec.disk.type`      | Inline storage type. Use `disk`.                 | Yes, when `disk` is used |
| `spec.disk.mountPath` | Container path where the inline disk is mounted. | Yes, when `disk` is used |

## `spec.use.volumes[]` fields

| Field                          | Description                                        | Required                        |
| ------------------------------ | -------------------------------------------------- | ------------------------------- |
| `spec.use.volumes[].id`        | Volume Resource identifier.                        | Yes, when `use.volumes` is used |
| `spec.use.volumes[].directory` | Container path where the Volume is mounted.        | Yes, when `use.volumes` is used |
| `spec.use.volumes[].readOnly`  | Mounts the Volume as read-only when set to `true`. | No                              |

## Notes

* Set `stateful: true` when the Service needs stable storage behavior.
* Use `disk` when storage belongs to the Service lifecycle.
* Use `use.volumes` when storage should outlive the Service.

For behavior and usage guidance, see [Core concepts](https://v2.dataos.info/references/resources/service/core-concepts.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://v2.dataos.info/references/resources/service/field-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
