Skip to main content
Version: 14.x (Next)

Infrastructure resource

Infrastructure resources are custom objects that are not part of the standard Console supported resources. They can be managed from the dedicated section of the Console Design area.

To create or edit an infrastructure resource, you need to provide a manifest, whose resources property should adhere to the following JSON schema.

tip

The JSON schemas of the infrastructure resource resources and of the full infrastructure resource manifest are available on GitHub.

Loading ....

Monitor a Custom Kubernetes Resource in the Runtime area​

If you've upgraded to Console release v13.3.0, you can now view the status of your Current Kubernetes Resources directly in the Runtime section. To enable this feature, publish a new version of your infrastructure resource that include the fields runtime.

Generate dynamic form to customize validation​

If you have upgraded the Console to version v13.6.1, you can now generate a dynamic form. This documentation serves as a guide for users to understand and effectively utilize the dynamic form fields generated from a JSON schema. By following the examples and descriptions provided, users can create forms that are both functional and user-friendly, ensuring a smooth data entry experience.

info

In the next versions of the Console we want to add dynamic form generation also in the details section.

The Frontend of the Console generate the Form using the roles below:

Supported JSON Schema Types​

Object field​

Visualized as Editor

type-object

```json
{
  "jsonSchema": {
    "type": "object",
    "required": ["mirroring"],
    "properties" {
      "mirroring": { "type": "object", "description": "Mirroring defines the Mirroring service configuration" }
    }
  }
}
```
Validation​

The editor generated from this type can validate with ajv library the sub schema used to fields

type-object-validation

```json
{
  "jsonSchema": {
    "type": "object",
    "required": ["mirroring"],
    "properties" {
      "mirroring": { 
        "type": "object",
        "additionalProperties": false,
        "required": ["name"],
        "properties": {
          "name": { "type": "string" }
        } 
      }
    }
  }
}
```

Unsupported JSON Schema Features​

While our dynamic form fields support a wide range of JSON schema features, there are certain features that are not supported. Additionally, being aware of the unsupported features will help users avoid potential issues when designing their schemas. Below is a list of unsupported features:

  • $ref: Reference to external schemas
  • oneOf: Validation against one of the specified schemas
  • allOf: Validation against all of the specified schemas
  • anyOf: Validation against any of the specified schemas
  • not: Validation against the negation of the specified schema
  • string format: Specific string formats such as email, date, etc
  • number exclusiveMinimum and exclusiveMaximum: Exclusive range validation for numbers
  • dependencies: Conditional validation based on the presence of other fields

Partially supported JSON Schema Features​

  • additionalProperties: Validation of additional properties work only for types array or object in the schema
  • patternProperties: Validation of properties matching a specific pattern