Skip to content

Commit

Permalink
chore: fix title capitalization and remove ordering (KusionStack#408)
Browse files Browse the repository at this point in the history
  • Loading branch information
ffforest authored Jan 12, 2024
1 parent 67bedbd commit ca073fa
Show file tree
Hide file tree
Showing 25 changed files with 11 additions and 41 deletions.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
---
id: app-configuration
sidebar_label: AppConfiguration
---

# AppConfiguration
# appconfiguration

## Schema AppConfiguration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ WorkloadBase defines set of attributes shared by different workload profile, e.g

|Name and Description|Type|Default Value|Required|
|--------------------|----|-------------|--------|
|**containers**<br />Containers defines the templates of containers to be ran.<br />More info: https://kubernetes.io/docs/concepts/containers|{str: [container.Container](container/container#schema-container)}|Undefined|**required**|
|**secrets**|{str: [secret.Secret](secret/secret#schema-secret)}|Undefined|optional|
|**containers**<br />Containers defines the templates of containers to be ran.<br />More info: https://kubernetes.io/docs/concepts/containers|{str: [container.Container](container/container.md#schema-container)}|Undefined|**required**|
|**secrets**|{str: [secret.Secret](secret/secret.md#schema-secret)}|Undefined|optional|
|**replicas**<br />Number of container replicas based on this configuration that should be ran.|int|2|**required**|
|**labels**<br />Labels are key/value pairs that are attached to the workload.|{str: str}|Undefined|optional|
|**annotations**<br />Annotations are key/value pairs that attach arbitrary non-identifying metadata to the workload.|{str: str}|Undefined|optional|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Container describes how the Application's tasks are expected to be run. Dependin
|**resources**<br />Map of resource requirements the container should run with.<br />The resources parameter is a dict with the key being the resource name and the value being<br />the resource value.|{str: str}|Undefined|optional|
|**files**<br />List of files to create in the container.<br />The files parameter is a dict with the key being the file name in the container and the value<br />being the target file specification.|{str: [container.FileSpec](#schema-filespec)}|Undefined|optional|
|**dirs**<br />Collection of volumes mount into the container's filesystem.<br />The dirs parameter is a dict with the key being the folder name in the container and the value<br />being the referenced volume.|{str: str}|Undefined|optional|
|**livenessProbe**<br />LivenessProbe indicates if a running process is healthy.<br />Container will be restarted if the probe fails.|[p.Probe](probe/probe#schema-probe)|Undefined|optional|
|**readinessProbe**<br />ReadinessProbe indicates whether an application is available to handle requests.|[p.Probe](probe/probe#schema-probe)|Undefined|optional|
|**startupProbe**<br />StartupProbe indicates that the container has started for the first time.<br />Container will be restarted if the probe fails.|[p.Probe](probe/probe#schema-probe)|Undefined|optional|
|**lifecycle**<br />Lifecycle refers to actions that the management system should take in response to container lifecycle events.|[lc.Lifecycle](lifecycle/lifecycle#schema-lifecycle)|Undefined|optional|
|**livenessProbe**<br />LivenessProbe indicates if a running process is healthy.<br />Container will be restarted if the probe fails.|[p.Probe](probe/probe.md#schema-probe)|Undefined|optional|
|**readinessProbe**<br />ReadinessProbe indicates whether an application is available to handle requests.|[p.Probe](probe/probe.md#schema-probe)|Undefined|optional|
|**startupProbe**<br />StartupProbe indicates that the container has started for the first time.<br />Container will be restarted if the probe fails.|[p.Probe](probe/probe.md#schema-probe)|Undefined|optional|
|**lifecycle**<br />Lifecycle refers to actions that the management system should take in response to container lifecycle events.|[lc.Lifecycle](lifecycle/lifecycle.md#schema-lifecycle)|Undefined|optional|
### Examples
```python
import catalog.models.schema.v1.workload.container as c
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Lifecycle describes actions that the management system should take in response<b

|Name and Description|Type|Default Value|Required|
|--------------------|----|-------------|--------|
|**preStop**<br />The action to be taken before a container is terminated due to an API request or<br />management event such as liveness/startup probe failure, preemption, resource contention, etc.<br />More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/\#container-hooks|[probe.Exec](../probe/probe#schema-exec) \| [probe.Http](../probe/probe#schema-http)|Undefined|optional|
|**postStart**<br />The action to be taken after a container is created.<br />More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/\#container-hooks|[probe.Exec](../probe/probe#schema-exec) \| [probe.Http](../probe/probe#schema-http)|Undefined|optional|
|**preStop**<br />The action to be taken before a container is terminated due to an API request or<br />management event such as liveness/startup probe failure, preemption, resource contention, etc.<br />More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/\#container-hooks|[probe.Exec](../probe/probe.md#schema-exec) \| [probe.Http](../probe/probe.md#schema-http)|Undefined|optional|
|**postStart**<br />The action to be taken after a container is created.<br />More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/\#container-hooks|[probe.Exec](../probe/probe.md#schema-exec) \| [probe.Http](../probe/probe.md#schema-http)|Undefined|optional|
### Examples
```python
import catalog.models.schema.v1.workload.container.probe as p
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Job
# job

## Schemas
- [Job](#schema-job)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Service
# service

## Schemas
- [Service](#schema-service)
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit ca073fa

Please sign in to comment.