Skip to content
API Enriched

Replace Configuration Specification.

PUT
/api/config/namespaces/{metadata.namespace}/k8s_cluster_roles/{metadata.name}
curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/k8s_cluster_roles/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "k8s_cluster_role_selector": { "expressions": [ "example" ] }, "policy_rule_list": { "policy_rule": [ { "non_resource_url_list": { "urls": [ "example" ], "verbs": [ "example" ] }, "resource_list": { "api_groups": [ "example" ], "resource_instances": [ "example" ], "resource_types": [ "example" ], "verbs": [ "example" ] } } ] }, "yaml": "example" } }'

Replacing an k8s_cluster_role object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
metadata.namespace
required
string

Namespace This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

metadata.name
required
string

Name The configuration object to be replaced will be looked up by name.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ReplaceRequest is used to replace contents of a k8s_cluster_role

This is the input message of the ‘Replace’ RPC.

object
metadata
object
annotations
annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object
description
description

Human readable description for the object.

string
>= 21 characters <= 1200 characters
disable
disable

A value of true will administratively disable the object.

boolean format: boolean
labels
labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object
name
name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string
>= 6 characters <= 1024 characters
namespace
namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string
>= 6 characters <= 1024 characters
spec
object
k8s_cluster_role_selector
object
expressions
expressions

Expressions contains the Kubernetes style label expression for selections. Required: YES.

Array<string>
<= 1 items
policy_rule_list
object
policy_rule
Policy Rule List

List of rules for role permissions

Required: YES.

Array<object>
>= 1 items <= 16 items
Policy Rule

Rule for role permission.

object
non_resource_url_list
object
urls
Non Resource URL(s)

Allowed URL(s) that do not represent any K8s resource. URL can be suffix or regex. Required: YES.

Array<string>
>= 1 items <= 16 items
verbs
Allowed Verbs

Allowed list of verbs(operations) on resources. Use VerbAll for all operations Required: YES.

Array<string>
>= 1 items <= 16 items
resource_list
object
api_groups
API Groups

Allowed list of API group that contains resources, all resources of a given API group Required: YES.

Array<string>
>= 1 items <= 16 items
resource_instances
Resource Instances

Allowed list of resource instances within the resource types.

Array<string>
<= 16 items
resource_types
Resource Type

Allowed list of resource types within the API groups. Required: YES.

Array<string>
>= 1 items <= 16 items
verbs
Allowed Verbs

Allowed list of verbs(operations) on resources. Use * for all operations Required: YES.

Array<string>
>= 1 items <= 16 items
yaml

Exclusive with [k8s_cluster_role_selector policy_rule_list] K8s YAML for ClusterRole.

string
<= 4096 characters
Examplegenerated
{
  "metadata": {
    "annotations": {},
    "description": "example",
    "disable": true,
    "labels": {},
    "name": "example",
    "namespace": "example"
  },
  "spec": {
    "k8s_cluster_role_selector": {
      "expressions": [
        "example"
      ]
    },
    "policy_rule_list": {
      "policy_rule": [
        {
          "non_resource_url_list": {
            "urls": [
              "example"
            ],
            "verbs": [
              "example"
            ]
          },
          "resource_list": {
            "api_groups": [
              "example"
            ],
            "resource_instances": [
              "example"
            ],
            "resource_types": [
              "example"
            ],
            "verbs": [
              "example"
            ]
          }
        }
      ]
    },
    "yaml": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
object
Examplegenerated
{}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example