diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..65ff66e --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,19 @@ +"jobs": + "build": + "name": "Deploy docs" + "runs-on": "ubuntu-latest" + "steps": + - "name": "Checkout main" + "uses": "actions/checkout@v3" + "with": + "fetch-depth": 0 + - "uses": "actions/setup-python@v2" + - "run": "pip install -r requirements.txt" + - "run": "git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'" + - "name": "Publish docs" + "run": "mkdocs gh-deploy --force" +"name": "Publish docs via GitHub Pages" +"on": + "push": + "branches": + - "main" \ No newline at end of file diff --git a/0.1/_gen/pyrra/main.libsonnet b/0.1/_gen/pyrra/main.libsonnet new file mode 100644 index 0000000..351b5c4 --- /dev/null +++ b/0.1/_gen/pyrra/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.1/_gen/pyrra/v1alpha1/main.libsonnet b/0.1/_gen/pyrra/v1alpha1/main.libsonnet new file mode 100644 index 0000000..afbb7e7 --- /dev/null +++ b/0.1/_gen/pyrra/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + serviceLevelObjective: (import 'serviceLevelObjective.libsonnet'), +} diff --git a/0.1/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet b/0.1/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet new file mode 100644 index 0000000..e31e1d7 --- /dev/null +++ b/0.1/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet @@ -0,0 +1,90 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceLevelObjective', url='', help='"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceLevelObjective', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'pyrra.dev/v1alpha1', + kind: 'ServiceLevelObjective', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective"'), + spec: { + '#indicator':: d.obj(help='"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service."'), + indicator: { + '#latency':: d.obj(help='"Latency is the indicator that measures a certain percentage to be fast than."'), + latency: { + '#success':: d.obj(help='"Success is the metric that returns how many errors there are."'), + success: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { success+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { total+: { metric: metric } } } } }, + }, + }, + '#ratio':: d.obj(help='"Ratio is the indicator that measures against errors / total events."'), + ratio: { + '#errors':: d.obj(help='"Errors is the metric that returns how many errors there are."'), + errors: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { errors+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { total+: { metric: metric } } } } }, + }, + }, + }, + '#withDescription':: d.fn(help='"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { spec+: { description: description } }, + '#withTarget':: d.fn(help="\"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245\"", args=[d.arg(name='target', type=d.T.string)]), + withTarget(target): { spec+: { target: target } }, + '#withWindow':: d.fn(help='"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d."', args=[d.arg(name='window', type=d.T.string)]), + withWindow(window): { spec+: { window: window } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.1/gen.libsonnet b/0.1/gen.libsonnet new file mode 100644 index 0000000..532ad91 --- /dev/null +++ b/0.1/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='github.com/jsonnet-libs/pyrra-libsonnet/0.1/main.libsonnet', help=''), + pyrra:: (import '_gen/pyrra/main.libsonnet'), +} diff --git a/0.1/main.libsonnet b/0.1/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/0.1/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/0.2/_gen/pyrra/main.libsonnet b/0.2/_gen/pyrra/main.libsonnet new file mode 100644 index 0000000..351b5c4 --- /dev/null +++ b/0.2/_gen/pyrra/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.2/_gen/pyrra/v1alpha1/main.libsonnet b/0.2/_gen/pyrra/v1alpha1/main.libsonnet new file mode 100644 index 0000000..afbb7e7 --- /dev/null +++ b/0.2/_gen/pyrra/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + serviceLevelObjective: (import 'serviceLevelObjective.libsonnet'), +} diff --git a/0.2/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet b/0.2/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet new file mode 100644 index 0000000..e31e1d7 --- /dev/null +++ b/0.2/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet @@ -0,0 +1,90 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceLevelObjective', url='', help='"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceLevelObjective', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'pyrra.dev/v1alpha1', + kind: 'ServiceLevelObjective', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective"'), + spec: { + '#indicator':: d.obj(help='"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service."'), + indicator: { + '#latency':: d.obj(help='"Latency is the indicator that measures a certain percentage to be fast than."'), + latency: { + '#success':: d.obj(help='"Success is the metric that returns how many errors there are."'), + success: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { success+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { total+: { metric: metric } } } } }, + }, + }, + '#ratio':: d.obj(help='"Ratio is the indicator that measures against errors / total events."'), + ratio: { + '#errors':: d.obj(help='"Errors is the metric that returns how many errors there are."'), + errors: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { errors+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { total+: { metric: metric } } } } }, + }, + }, + }, + '#withDescription':: d.fn(help='"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { spec+: { description: description } }, + '#withTarget':: d.fn(help="\"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245\"", args=[d.arg(name='target', type=d.T.string)]), + withTarget(target): { spec+: { target: target } }, + '#withWindow':: d.fn(help='"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d."', args=[d.arg(name='window', type=d.T.string)]), + withWindow(window): { spec+: { window: window } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.2/gen.libsonnet b/0.2/gen.libsonnet new file mode 100644 index 0000000..03b175b --- /dev/null +++ b/0.2/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='github.com/jsonnet-libs/pyrra-libsonnet/0.2/main.libsonnet', help=''), + pyrra:: (import '_gen/pyrra/main.libsonnet'), +} diff --git a/0.2/main.libsonnet b/0.2/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/0.2/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/0.3/_gen/pyrra/main.libsonnet b/0.3/_gen/pyrra/main.libsonnet new file mode 100644 index 0000000..351b5c4 --- /dev/null +++ b/0.3/_gen/pyrra/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.3/_gen/pyrra/v1alpha1/main.libsonnet b/0.3/_gen/pyrra/v1alpha1/main.libsonnet new file mode 100644 index 0000000..afbb7e7 --- /dev/null +++ b/0.3/_gen/pyrra/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + serviceLevelObjective: (import 'serviceLevelObjective.libsonnet'), +} diff --git a/0.3/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet b/0.3/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet new file mode 100644 index 0000000..ce3dfb4 --- /dev/null +++ b/0.3/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet @@ -0,0 +1,98 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceLevelObjective', url='', help='"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API"'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceLevelObjective', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'pyrra.dev/v1alpha1', + kind: 'ServiceLevelObjective', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective"'), + spec: { + '#indicator':: d.obj(help='"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service."'), + indicator: { + '#latency':: d.obj(help='"Latency is the indicator that measures a certain percentage to be fast than."'), + latency: { + '#success':: d.obj(help='"Success is the metric that returns how many errors there are."'), + success: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { success+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { latency+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { latency+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + '#ratio':: d.obj(help='"Ratio is the indicator that measures against errors / total events."'), + ratio: { + '#errors':: d.obj(help='"Errors is the metric that returns how many errors there are."'), + errors: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { errors+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { ratio+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { ratio+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + }, + '#withDescription':: d.fn(help='"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { spec+: { description: description } }, + '#withTarget':: d.fn(help="\"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245\"", args=[d.arg(name='target', type=d.T.string)]), + withTarget(target): { spec+: { target: target } }, + '#withWindow':: d.fn(help='"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d."', args=[d.arg(name='window', type=d.T.string)]), + withWindow(window): { spec+: { window: window } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.3/gen.libsonnet b/0.3/gen.libsonnet new file mode 100644 index 0000000..710e17a --- /dev/null +++ b/0.3/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='github.com/jsonnet-libs/pyrra-libsonnet/0.3/main.libsonnet', help=''), + pyrra:: (import '_gen/pyrra/main.libsonnet'), +} diff --git a/0.3/main.libsonnet b/0.3/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/0.3/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/0.4/_gen/pyrra/main.libsonnet b/0.4/_gen/pyrra/main.libsonnet new file mode 100644 index 0000000..351b5c4 --- /dev/null +++ b/0.4/_gen/pyrra/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.4/_gen/pyrra/v1alpha1/main.libsonnet b/0.4/_gen/pyrra/v1alpha1/main.libsonnet new file mode 100644 index 0000000..afbb7e7 --- /dev/null +++ b/0.4/_gen/pyrra/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + serviceLevelObjective: (import 'serviceLevelObjective.libsonnet'), +} diff --git a/0.4/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet b/0.4/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet new file mode 100644 index 0000000..fc73afb --- /dev/null +++ b/0.4/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet @@ -0,0 +1,98 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceLevelObjective', url='', help='"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceLevelObjective', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'pyrra.dev/v1alpha1', + kind: 'ServiceLevelObjective', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective."'), + spec: { + '#indicator':: d.obj(help='"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service."'), + indicator: { + '#latency':: d.obj(help='"Latency is the indicator that measures a certain percentage to be fast than."'), + latency: { + '#success':: d.obj(help='"Success is the metric that returns how many errors there are."'), + success: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { success+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { latency+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { latency+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + '#ratio':: d.obj(help='"Ratio is the indicator that measures against errors / total events."'), + ratio: { + '#errors':: d.obj(help='"Errors is the metric that returns how many errors there are."'), + errors: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { errors+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { ratio+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { ratio+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + }, + '#withDescription':: d.fn(help='"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { spec+: { description: description } }, + '#withTarget':: d.fn(help="\"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245\"", args=[d.arg(name='target', type=d.T.string)]), + withTarget(target): { spec+: { target: target } }, + '#withWindow':: d.fn(help='"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d."', args=[d.arg(name='window', type=d.T.string)]), + withWindow(window): { spec+: { window: window } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.4/gen.libsonnet b/0.4/gen.libsonnet new file mode 100644 index 0000000..47e7bc1 --- /dev/null +++ b/0.4/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='github.com/jsonnet-libs/pyrra-libsonnet/0.4/main.libsonnet', help=''), + pyrra:: (import '_gen/pyrra/main.libsonnet'), +} diff --git a/0.4/main.libsonnet b/0.4/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/0.4/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/0.5/_gen/pyrra/main.libsonnet b/0.5/_gen/pyrra/main.libsonnet new file mode 100644 index 0000000..351b5c4 --- /dev/null +++ b/0.5/_gen/pyrra/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.5/_gen/pyrra/v1alpha1/main.libsonnet b/0.5/_gen/pyrra/v1alpha1/main.libsonnet new file mode 100644 index 0000000..afbb7e7 --- /dev/null +++ b/0.5/_gen/pyrra/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + serviceLevelObjective: (import 'serviceLevelObjective.libsonnet'), +} diff --git a/0.5/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet b/0.5/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet new file mode 100644 index 0000000..a54519f --- /dev/null +++ b/0.5/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet @@ -0,0 +1,105 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceLevelObjective', url='', help='"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceLevelObjective', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'pyrra.dev/v1alpha1', + kind: 'ServiceLevelObjective', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective."'), + spec: { + '#alerting':: d.obj(help='"Alerting customizes the alerting rules generated by Pyrra."'), + alerting: { + '#withDisabled':: d.fn(help='"Disabled is used to disable the generation of alerts. Recording rules are still generated."', args=[d.arg(name='disabled', type=d.T.boolean)]), + withDisabled(disabled): { spec+: { alerting+: { disabled: disabled } } }, + '#withName':: d.fn(help='"Name is used as the name of the alert generated by Pyrra. Defaults to \\"ErrorBudgetBurn\\"."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alerting+: { name: name } } }, + }, + '#indicator':: d.obj(help='"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service."'), + indicator: { + '#latency':: d.obj(help='"Latency is the indicator that measures a certain percentage to be fast than."'), + latency: { + '#success':: d.obj(help='"Success is the metric that returns how many errors there are."'), + success: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { success+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { latency+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { latency+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + '#ratio':: d.obj(help='"Ratio is the indicator that measures against errors / total events."'), + ratio: { + '#errors':: d.obj(help='"Errors is the metric that returns how many errors there are."'), + errors: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { errors+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { ratio+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { ratio+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + }, + '#withDescription':: d.fn(help='"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { spec+: { description: description } }, + '#withTarget':: d.fn(help="\"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245\"", args=[d.arg(name='target', type=d.T.string)]), + withTarget(target): { spec+: { target: target } }, + '#withWindow':: d.fn(help='"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d."', args=[d.arg(name='window', type=d.T.string)]), + withWindow(window): { spec+: { window: window } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.5/gen.libsonnet b/0.5/gen.libsonnet new file mode 100644 index 0000000..a366e70 --- /dev/null +++ b/0.5/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='github.com/jsonnet-libs/pyrra-libsonnet/0.5/main.libsonnet', help=''), + pyrra:: (import '_gen/pyrra/main.libsonnet'), +} diff --git a/0.5/main.libsonnet b/0.5/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/0.5/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/0.6/_gen/pyrra/main.libsonnet b/0.6/_gen/pyrra/main.libsonnet new file mode 100644 index 0000000..351b5c4 --- /dev/null +++ b/0.6/_gen/pyrra/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.6/_gen/pyrra/v1alpha1/main.libsonnet b/0.6/_gen/pyrra/v1alpha1/main.libsonnet new file mode 100644 index 0000000..afbb7e7 --- /dev/null +++ b/0.6/_gen/pyrra/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + serviceLevelObjective: (import 'serviceLevelObjective.libsonnet'), +} diff --git a/0.6/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet b/0.6/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet new file mode 100644 index 0000000..3d048ca --- /dev/null +++ b/0.6/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet @@ -0,0 +1,114 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceLevelObjective', url='', help='"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceLevelObjective', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'pyrra.dev/v1alpha1', + kind: 'ServiceLevelObjective', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective."'), + spec: { + '#alerting':: d.obj(help='"Alerting customizes the alerting rules generated by Pyrra."'), + alerting: { + '#withDisabled':: d.fn(help='"Disabled is used to disable the generation of alerts. Recording rules are still generated."', args=[d.arg(name='disabled', type=d.T.boolean)]), + withDisabled(disabled): { spec+: { alerting+: { disabled: disabled } } }, + '#withName':: d.fn(help='"Name is used as the name of the alert generated by Pyrra. Defaults to \\"ErrorBudgetBurn\\"."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alerting+: { name: name } } }, + }, + '#indicator':: d.obj(help='"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service."'), + indicator: { + '#bool_gauge':: d.obj(help='"BoolGauge is the indicator that measures wheter a boolean gauge is successul."'), + bool_gauge: { + '#withGrouping':: d.fn(help='"Total is the metric that returns how many requests there are in total."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { bool_gauge+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Total is the metric that returns how many requests there are in total."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { bool_gauge+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { bool_gauge+: { metric: metric } } } }, + }, + '#latency':: d.obj(help='"Latency is the indicator that measures a certain percentage to be fast than."'), + latency: { + '#success':: d.obj(help='"Success is the metric that returns how many errors there are."'), + success: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { success+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { latency+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { latency+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + '#ratio':: d.obj(help='"Ratio is the indicator that measures against errors / total events."'), + ratio: { + '#errors':: d.obj(help='"Errors is the metric that returns how many errors there are."'), + errors: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { errors+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { ratio+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { ratio+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + }, + '#withDescription':: d.fn(help='"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { spec+: { description: description } }, + '#withTarget':: d.fn(help="\"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245\"", args=[d.arg(name='target', type=d.T.string)]), + withTarget(target): { spec+: { target: target } }, + '#withWindow':: d.fn(help='"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d."', args=[d.arg(name='window', type=d.T.string)]), + withWindow(window): { spec+: { window: window } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.6/gen.libsonnet b/0.6/gen.libsonnet new file mode 100644 index 0000000..5e9932c --- /dev/null +++ b/0.6/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='github.com/jsonnet-libs/pyrra-libsonnet/0.6/main.libsonnet', help=''), + pyrra:: (import '_gen/pyrra/main.libsonnet'), +} diff --git a/0.6/main.libsonnet b/0.6/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/0.6/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/0.7/_gen/pyrra/main.libsonnet b/0.7/_gen/pyrra/main.libsonnet new file mode 100644 index 0000000..351b5c4 --- /dev/null +++ b/0.7/_gen/pyrra/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='', help=''), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.7/_gen/pyrra/v1alpha1/main.libsonnet b/0.7/_gen/pyrra/v1alpha1/main.libsonnet new file mode 100644 index 0000000..afbb7e7 --- /dev/null +++ b/0.7/_gen/pyrra/v1alpha1/main.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + serviceLevelObjective: (import 'serviceLevelObjective.libsonnet'), +} diff --git a/0.7/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet b/0.7/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet new file mode 100644 index 0000000..273d745 --- /dev/null +++ b/0.7/_gen/pyrra/v1alpha1/serviceLevelObjective.libsonnet @@ -0,0 +1,132 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceLevelObjective', url='', help='"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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. More info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\\n\\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\\n\\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \\"default\\" namespace, but \\"default\\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\\n\\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\\n\\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"SelfLink is a URL representing this object. Populated by the system. Read-only.\\n\\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\\n\\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceLevelObjective', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'pyrra.dev/v1alpha1', + kind: 'ServiceLevelObjective', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective."'), + spec: { + '#alerting':: d.obj(help='"Alerting customizes the alerting rules generated by Pyrra."'), + alerting: { + '#withAbsent':: d.fn(help='', args=[d.arg(name='absent', type=d.T.boolean)]), + withAbsent(absent): { spec+: { alerting+: { absent: absent } } }, + '#withBurnrates':: d.fn(help='', args=[d.arg(name='burnrates', type=d.T.boolean)]), + withBurnrates(burnrates): { spec+: { alerting+: { burnrates: burnrates } } }, + '#withDisabled':: d.fn(help='"Disabled is used to disable the generation of alerts. Recording rules are still generated."', args=[d.arg(name='disabled', type=d.T.boolean)]), + withDisabled(disabled): { spec+: { alerting+: { disabled: disabled } } }, + '#withName':: d.fn(help='"Name is used as the name of the alert generated by Pyrra. Defaults to \\"ErrorBudgetBurn\\"."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alerting+: { name: name } } }, + }, + '#indicator':: d.obj(help='"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service."'), + indicator: { + '#bool_gauge':: d.obj(help='"BoolGauge is the indicator that measures whether a boolean gauge is successful."'), + bool_gauge: { + '#withGrouping':: d.fn(help='"Total is the metric that returns how many requests there are in total."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { bool_gauge+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Total is the metric that returns how many requests there are in total."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { bool_gauge+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { bool_gauge+: { metric: metric } } } }, + }, + '#latency':: d.obj(help='"Latency is the indicator that measures a certain percentage to be faster than the expected latency."'), + latency: { + '#success':: d.obj(help='"Success is the metric that returns how many errors there are."'), + success: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { success+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latency+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { latency+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { latency+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + '#latencyNative':: d.obj(help='"LatencyNative is the indicator that measures a certain percentage to be faster than the expected latency. This uses the new native histograms in Prometheus."'), + latencyNative: { + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { latencyNative+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { latencyNative+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { latencyNative+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withLatency':: d.fn(help='"Latency the requests should be faster than."', args=[d.arg(name='latency', type=d.T.string)]), + withLatency(latency): { spec+: { indicator+: { latencyNative+: { latency: latency } } } }, + }, + '#ratio':: d.obj(help='"Ratio is the indicator that measures against errors / total events."'), + ratio: { + '#errors':: d.obj(help='"Errors is the metric that returns how many errors there are."'), + errors: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { errors+: { metric: metric } } } } }, + }, + '#total':: d.obj(help='"Total is the metric that returns how many requests there are in total."'), + total: { + '#withMetric':: d.fn(help='', args=[d.arg(name='metric', type=d.T.string)]), + withMetric(metric): { spec+: { indicator+: { ratio+: { total+: { metric: metric } } } } }, + }, + '#withGrouping':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."', args=[d.arg(name='grouping', type=d.T.array)]), + withGrouping(grouping): { spec+: { indicator+: { ratio+: { grouping: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + '#withGroupingMixin':: d.fn(help='"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='grouping', type=d.T.array)]), + withGroupingMixin(grouping): { spec+: { indicator+: { ratio+: { grouping+: if std.isArray(v=grouping) then grouping else [grouping] } } } }, + }, + }, + '#withDescription':: d.fn(help='"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { spec+: { description: description } }, + '#withTarget':: d.fn(help="\"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245\"", args=[d.arg(name='target', type=d.T.string)]), + withTarget(target): { spec+: { target: target } }, + '#withWindow':: d.fn(help='"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d."', args=[d.arg(name='window', type=d.T.string)]), + withWindow(window): { spec+: { window: window } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.7/gen.libsonnet b/0.7/gen.libsonnet new file mode 100644 index 0000000..987c4f9 --- /dev/null +++ b/0.7/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='pyrra', url='github.com/jsonnet-libs/pyrra-libsonnet/0.7/main.libsonnet', help=''), + pyrra:: (import '_gen/pyrra/main.libsonnet'), +} diff --git a/0.7/main.libsonnet b/0.7/main.libsonnet new file mode 100644 index 0000000..f5597a5 --- /dev/null +++ b/0.7/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..985645d --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2021 Grafana Labs, sh0rez, Duologic + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index a7e250f..10f09bb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ -# pyrra-libsonnet -pyrra jsonnet library +# pyrra Jsonnet library + +This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). + +[Docs](https://jsonnet-libs.github.io/pyrra-libsonnet) diff --git a/docs/0.1/README.md b/docs/0.1/README.md new file mode 100644 index 0000000..b221b69 --- /dev/null +++ b/docs/0.1/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.1/ +--- + +# pyrra + +```jsonnet +local pyrra = import "github.com/jsonnet-libs/pyrra-libsonnet/0.1/main.libsonnet" +``` + + + +* [pyrra](pyrra/index.md) \ No newline at end of file diff --git a/docs/0.1/pyrra/index.md b/docs/0.1/pyrra/index.md new file mode 100644 index 0000000..5b0b39a --- /dev/null +++ b/docs/0.1/pyrra/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.1/pyrra/ +--- + +# pyrra + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.1/pyrra/v1alpha1/index.md b/docs/0.1/pyrra/v1alpha1/index.md new file mode 100644 index 0000000..a071d60 --- /dev/null +++ b/docs/0.1/pyrra/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.1/pyrra/v1alpha1/ +--- + +# pyrra.v1alpha1 + + + +* [serviceLevelObjective](serviceLevelObjective.md) \ No newline at end of file diff --git a/docs/0.1/pyrra/v1alpha1/serviceLevelObjective.md b/docs/0.1/pyrra/v1alpha1/serviceLevelObjective.md new file mode 100644 index 0000000..e235201 --- /dev/null +++ b/docs/0.1/pyrra/v1alpha1/serviceLevelObjective.md @@ -0,0 +1,307 @@ +--- +permalink: /0.1/pyrra/v1alpha1/serviceLevelObjective/ +--- + +# pyrra.v1alpha1.serviceLevelObjective + +"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDescription(description)`](#fn-specwithdescription) + * [`fn withTarget(target)`](#fn-specwithtarget) + * [`fn withWindow(window)`](#fn-specwithwindow) + * [`obj spec.indicator`](#obj-specindicator) + * [`obj spec.indicator.latency`](#obj-specindicatorlatency) + * [`obj spec.indicator.latency.success`](#obj-specindicatorlatencysuccess) + * [`fn withMetric(metric)`](#fn-specindicatorlatencysuccesswithmetric) + * [`obj spec.indicator.latency.total`](#obj-specindicatorlatencytotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencytotalwithmetric) + * [`obj spec.indicator.ratio`](#obj-specindicatorratio) + * [`obj spec.indicator.ratio.errors`](#obj-specindicatorratioerrors) + * [`fn withMetric(metric)`](#fn-specindicatorratioerrorswithmetric) + * [`obj spec.indicator.ratio.total`](#obj-specindicatorratiototal) + * [`fn withMetric(metric)`](#fn-specindicatorratiototalwithmetric) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceLevelObjective + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective" + +### fn spec.withDescription + +```ts +withDescription(description) +``` + +"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service." + +### fn spec.withTarget + +```ts +withTarget(target) +``` + +"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245" + +### fn spec.withWindow + +```ts +withWindow(window) +``` + +"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d." + +## obj spec.indicator + +"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service." + +## obj spec.indicator.latency + +"Latency is the indicator that measures a certain percentage to be fast than." + +## obj spec.indicator.latency.success + +"Success is the metric that returns how many errors there are." + +### fn spec.indicator.latency.success.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latency.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio + +"Ratio is the indicator that measures against errors / total events." + +## obj spec.indicator.ratio.errors + +"Errors is the metric that returns how many errors there are." + +### fn spec.indicator.ratio.errors.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.ratio.total.withMetric + +```ts +withMetric(metric) +``` + diff --git a/docs/0.2/README.md b/docs/0.2/README.md new file mode 100644 index 0000000..d20b0e2 --- /dev/null +++ b/docs/0.2/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.2/ +--- + +# pyrra + +```jsonnet +local pyrra = import "github.com/jsonnet-libs/pyrra-libsonnet/0.2/main.libsonnet" +``` + + + +* [pyrra](pyrra/index.md) \ No newline at end of file diff --git a/docs/0.2/pyrra/index.md b/docs/0.2/pyrra/index.md new file mode 100644 index 0000000..13b233b --- /dev/null +++ b/docs/0.2/pyrra/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.2/pyrra/ +--- + +# pyrra + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.2/pyrra/v1alpha1/index.md b/docs/0.2/pyrra/v1alpha1/index.md new file mode 100644 index 0000000..5fea2a0 --- /dev/null +++ b/docs/0.2/pyrra/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.2/pyrra/v1alpha1/ +--- + +# pyrra.v1alpha1 + + + +* [serviceLevelObjective](serviceLevelObjective.md) \ No newline at end of file diff --git a/docs/0.2/pyrra/v1alpha1/serviceLevelObjective.md b/docs/0.2/pyrra/v1alpha1/serviceLevelObjective.md new file mode 100644 index 0000000..139f14c --- /dev/null +++ b/docs/0.2/pyrra/v1alpha1/serviceLevelObjective.md @@ -0,0 +1,307 @@ +--- +permalink: /0.2/pyrra/v1alpha1/serviceLevelObjective/ +--- + +# pyrra.v1alpha1.serviceLevelObjective + +"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDescription(description)`](#fn-specwithdescription) + * [`fn withTarget(target)`](#fn-specwithtarget) + * [`fn withWindow(window)`](#fn-specwithwindow) + * [`obj spec.indicator`](#obj-specindicator) + * [`obj spec.indicator.latency`](#obj-specindicatorlatency) + * [`obj spec.indicator.latency.success`](#obj-specindicatorlatencysuccess) + * [`fn withMetric(metric)`](#fn-specindicatorlatencysuccesswithmetric) + * [`obj spec.indicator.latency.total`](#obj-specindicatorlatencytotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencytotalwithmetric) + * [`obj spec.indicator.ratio`](#obj-specindicatorratio) + * [`obj spec.indicator.ratio.errors`](#obj-specindicatorratioerrors) + * [`fn withMetric(metric)`](#fn-specindicatorratioerrorswithmetric) + * [`obj spec.indicator.ratio.total`](#obj-specindicatorratiototal) + * [`fn withMetric(metric)`](#fn-specindicatorratiototalwithmetric) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceLevelObjective + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective" + +### fn spec.withDescription + +```ts +withDescription(description) +``` + +"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service." + +### fn spec.withTarget + +```ts +withTarget(target) +``` + +"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245" + +### fn spec.withWindow + +```ts +withWindow(window) +``` + +"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d." + +## obj spec.indicator + +"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service." + +## obj spec.indicator.latency + +"Latency is the indicator that measures a certain percentage to be fast than." + +## obj spec.indicator.latency.success + +"Success is the metric that returns how many errors there are." + +### fn spec.indicator.latency.success.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latency.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio + +"Ratio is the indicator that measures against errors / total events." + +## obj spec.indicator.ratio.errors + +"Errors is the metric that returns how many errors there are." + +### fn spec.indicator.ratio.errors.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.ratio.total.withMetric + +```ts +withMetric(metric) +``` + diff --git a/docs/0.3/README.md b/docs/0.3/README.md new file mode 100644 index 0000000..2c690f0 --- /dev/null +++ b/docs/0.3/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.3/ +--- + +# pyrra + +```jsonnet +local pyrra = import "github.com/jsonnet-libs/pyrra-libsonnet/0.3/main.libsonnet" +``` + + + +* [pyrra](pyrra/index.md) \ No newline at end of file diff --git a/docs/0.3/pyrra/index.md b/docs/0.3/pyrra/index.md new file mode 100644 index 0000000..b0e4a8c --- /dev/null +++ b/docs/0.3/pyrra/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.3/pyrra/ +--- + +# pyrra + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.3/pyrra/v1alpha1/index.md b/docs/0.3/pyrra/v1alpha1/index.md new file mode 100644 index 0000000..5e5da0a --- /dev/null +++ b/docs/0.3/pyrra/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.3/pyrra/v1alpha1/ +--- + +# pyrra.v1alpha1 + + + +* [serviceLevelObjective](serviceLevelObjective.md) \ No newline at end of file diff --git a/docs/0.3/pyrra/v1alpha1/serviceLevelObjective.md b/docs/0.3/pyrra/v1alpha1/serviceLevelObjective.md new file mode 100644 index 0000000..e2b43d4 --- /dev/null +++ b/docs/0.3/pyrra/v1alpha1/serviceLevelObjective.md @@ -0,0 +1,347 @@ +--- +permalink: /0.3/pyrra/v1alpha1/serviceLevelObjective/ +--- + +# pyrra.v1alpha1.serviceLevelObjective + +"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API" + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDescription(description)`](#fn-specwithdescription) + * [`fn withTarget(target)`](#fn-specwithtarget) + * [`fn withWindow(window)`](#fn-specwithwindow) + * [`obj spec.indicator`](#obj-specindicator) + * [`obj spec.indicator.latency`](#obj-specindicatorlatency) + * [`fn withGrouping(grouping)`](#fn-specindicatorlatencywithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorlatencywithgroupingmixin) + * [`obj spec.indicator.latency.success`](#obj-specindicatorlatencysuccess) + * [`fn withMetric(metric)`](#fn-specindicatorlatencysuccesswithmetric) + * [`obj spec.indicator.latency.total`](#obj-specindicatorlatencytotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencytotalwithmetric) + * [`obj spec.indicator.ratio`](#obj-specindicatorratio) + * [`fn withGrouping(grouping)`](#fn-specindicatorratiowithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorratiowithgroupingmixin) + * [`obj spec.indicator.ratio.errors`](#obj-specindicatorratioerrors) + * [`fn withMetric(metric)`](#fn-specindicatorratioerrorswithmetric) + * [`obj spec.indicator.ratio.total`](#obj-specindicatorratiototal) + * [`fn withMetric(metric)`](#fn-specindicatorratiototalwithmetric) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceLevelObjective + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective" + +### fn spec.withDescription + +```ts +withDescription(description) +``` + +"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service." + +### fn spec.withTarget + +```ts +withTarget(target) +``` + +"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245" + +### fn spec.withWindow + +```ts +withWindow(window) +``` + +"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d." + +## obj spec.indicator + +"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service." + +## obj spec.indicator.latency + +"Latency is the indicator that measures a certain percentage to be fast than." + +### fn spec.indicator.latency.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.latency.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.latency.success + +"Success is the metric that returns how many errors there are." + +### fn spec.indicator.latency.success.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latency.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio + +"Ratio is the indicator that measures against errors / total events." + +### fn spec.indicator.ratio.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.ratio.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.ratio.errors + +"Errors is the metric that returns how many errors there are." + +### fn spec.indicator.ratio.errors.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.ratio.total.withMetric + +```ts +withMetric(metric) +``` + diff --git a/docs/0.4/README.md b/docs/0.4/README.md new file mode 100644 index 0000000..09ba241 --- /dev/null +++ b/docs/0.4/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.4/ +--- + +# pyrra + +```jsonnet +local pyrra = import "github.com/jsonnet-libs/pyrra-libsonnet/0.4/main.libsonnet" +``` + + + +* [pyrra](pyrra/index.md) \ No newline at end of file diff --git a/docs/0.4/pyrra/index.md b/docs/0.4/pyrra/index.md new file mode 100644 index 0000000..d436e13 --- /dev/null +++ b/docs/0.4/pyrra/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.4/pyrra/ +--- + +# pyrra + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.4/pyrra/v1alpha1/index.md b/docs/0.4/pyrra/v1alpha1/index.md new file mode 100644 index 0000000..0d17b6d --- /dev/null +++ b/docs/0.4/pyrra/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.4/pyrra/v1alpha1/ +--- + +# pyrra.v1alpha1 + + + +* [serviceLevelObjective](serviceLevelObjective.md) \ No newline at end of file diff --git a/docs/0.4/pyrra/v1alpha1/serviceLevelObjective.md b/docs/0.4/pyrra/v1alpha1/serviceLevelObjective.md new file mode 100644 index 0000000..f8ee1d7 --- /dev/null +++ b/docs/0.4/pyrra/v1alpha1/serviceLevelObjective.md @@ -0,0 +1,347 @@ +--- +permalink: /0.4/pyrra/v1alpha1/serviceLevelObjective/ +--- + +# pyrra.v1alpha1.serviceLevelObjective + +"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDescription(description)`](#fn-specwithdescription) + * [`fn withTarget(target)`](#fn-specwithtarget) + * [`fn withWindow(window)`](#fn-specwithwindow) + * [`obj spec.indicator`](#obj-specindicator) + * [`obj spec.indicator.latency`](#obj-specindicatorlatency) + * [`fn withGrouping(grouping)`](#fn-specindicatorlatencywithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorlatencywithgroupingmixin) + * [`obj spec.indicator.latency.success`](#obj-specindicatorlatencysuccess) + * [`fn withMetric(metric)`](#fn-specindicatorlatencysuccesswithmetric) + * [`obj spec.indicator.latency.total`](#obj-specindicatorlatencytotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencytotalwithmetric) + * [`obj spec.indicator.ratio`](#obj-specindicatorratio) + * [`fn withGrouping(grouping)`](#fn-specindicatorratiowithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorratiowithgroupingmixin) + * [`obj spec.indicator.ratio.errors`](#obj-specindicatorratioerrors) + * [`fn withMetric(metric)`](#fn-specindicatorratioerrorswithmetric) + * [`obj spec.indicator.ratio.total`](#obj-specindicatorratiototal) + * [`fn withMetric(metric)`](#fn-specindicatorratiototalwithmetric) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceLevelObjective + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective." + +### fn spec.withDescription + +```ts +withDescription(description) +``` + +"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service." + +### fn spec.withTarget + +```ts +withTarget(target) +``` + +"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245" + +### fn spec.withWindow + +```ts +withWindow(window) +``` + +"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d." + +## obj spec.indicator + +"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service." + +## obj spec.indicator.latency + +"Latency is the indicator that measures a certain percentage to be fast than." + +### fn spec.indicator.latency.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.latency.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.latency.success + +"Success is the metric that returns how many errors there are." + +### fn spec.indicator.latency.success.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latency.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio + +"Ratio is the indicator that measures against errors / total events." + +### fn spec.indicator.ratio.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.ratio.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.ratio.errors + +"Errors is the metric that returns how many errors there are." + +### fn spec.indicator.ratio.errors.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.ratio.total.withMetric + +```ts +withMetric(metric) +``` + diff --git a/docs/0.5/README.md b/docs/0.5/README.md new file mode 100644 index 0000000..02d0c9b --- /dev/null +++ b/docs/0.5/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.5/ +--- + +# pyrra + +```jsonnet +local pyrra = import "github.com/jsonnet-libs/pyrra-libsonnet/0.5/main.libsonnet" +``` + + + +* [pyrra](pyrra/index.md) \ No newline at end of file diff --git a/docs/0.5/pyrra/index.md b/docs/0.5/pyrra/index.md new file mode 100644 index 0000000..11e7df7 --- /dev/null +++ b/docs/0.5/pyrra/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.5/pyrra/ +--- + +# pyrra + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.5/pyrra/v1alpha1/index.md b/docs/0.5/pyrra/v1alpha1/index.md new file mode 100644 index 0000000..5d5e17f --- /dev/null +++ b/docs/0.5/pyrra/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.5/pyrra/v1alpha1/ +--- + +# pyrra.v1alpha1 + + + +* [serviceLevelObjective](serviceLevelObjective.md) \ No newline at end of file diff --git a/docs/0.5/pyrra/v1alpha1/serviceLevelObjective.md b/docs/0.5/pyrra/v1alpha1/serviceLevelObjective.md new file mode 100644 index 0000000..0482440 --- /dev/null +++ b/docs/0.5/pyrra/v1alpha1/serviceLevelObjective.md @@ -0,0 +1,370 @@ +--- +permalink: /0.5/pyrra/v1alpha1/serviceLevelObjective/ +--- + +# pyrra.v1alpha1.serviceLevelObjective + +"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDescription(description)`](#fn-specwithdescription) + * [`fn withTarget(target)`](#fn-specwithtarget) + * [`fn withWindow(window)`](#fn-specwithwindow) + * [`obj spec.alerting`](#obj-specalerting) + * [`fn withDisabled(disabled)`](#fn-specalertingwithdisabled) + * [`fn withName(name)`](#fn-specalertingwithname) + * [`obj spec.indicator`](#obj-specindicator) + * [`obj spec.indicator.latency`](#obj-specindicatorlatency) + * [`fn withGrouping(grouping)`](#fn-specindicatorlatencywithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorlatencywithgroupingmixin) + * [`obj spec.indicator.latency.success`](#obj-specindicatorlatencysuccess) + * [`fn withMetric(metric)`](#fn-specindicatorlatencysuccesswithmetric) + * [`obj spec.indicator.latency.total`](#obj-specindicatorlatencytotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencytotalwithmetric) + * [`obj spec.indicator.ratio`](#obj-specindicatorratio) + * [`fn withGrouping(grouping)`](#fn-specindicatorratiowithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorratiowithgroupingmixin) + * [`obj spec.indicator.ratio.errors`](#obj-specindicatorratioerrors) + * [`fn withMetric(metric)`](#fn-specindicatorratioerrorswithmetric) + * [`obj spec.indicator.ratio.total`](#obj-specindicatorratiototal) + * [`fn withMetric(metric)`](#fn-specindicatorratiototalwithmetric) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceLevelObjective + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective." + +### fn spec.withDescription + +```ts +withDescription(description) +``` + +"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service." + +### fn spec.withTarget + +```ts +withTarget(target) +``` + +"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245" + +### fn spec.withWindow + +```ts +withWindow(window) +``` + +"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d." + +## obj spec.alerting + +"Alerting customizes the alerting rules generated by Pyrra." + +### fn spec.alerting.withDisabled + +```ts +withDisabled(disabled) +``` + +"Disabled is used to disable the generation of alerts. Recording rules are still generated." + +### fn spec.alerting.withName + +```ts +withName(name) +``` + +"Name is used as the name of the alert generated by Pyrra. Defaults to \"ErrorBudgetBurn\"." + +## obj spec.indicator + +"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service." + +## obj spec.indicator.latency + +"Latency is the indicator that measures a certain percentage to be fast than." + +### fn spec.indicator.latency.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.latency.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.latency.success + +"Success is the metric that returns how many errors there are." + +### fn spec.indicator.latency.success.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latency.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio + +"Ratio is the indicator that measures against errors / total events." + +### fn spec.indicator.ratio.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.ratio.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.ratio.errors + +"Errors is the metric that returns how many errors there are." + +### fn spec.indicator.ratio.errors.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.ratio.total.withMetric + +```ts +withMetric(metric) +``` + diff --git a/docs/0.6/README.md b/docs/0.6/README.md new file mode 100644 index 0000000..78dc812 --- /dev/null +++ b/docs/0.6/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.6/ +--- + +# pyrra + +```jsonnet +local pyrra = import "github.com/jsonnet-libs/pyrra-libsonnet/0.6/main.libsonnet" +``` + + + +* [pyrra](pyrra/index.md) \ No newline at end of file diff --git a/docs/0.6/pyrra/index.md b/docs/0.6/pyrra/index.md new file mode 100644 index 0000000..878587f --- /dev/null +++ b/docs/0.6/pyrra/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.6/pyrra/ +--- + +# pyrra + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.6/pyrra/v1alpha1/index.md b/docs/0.6/pyrra/v1alpha1/index.md new file mode 100644 index 0000000..7d6ac52 --- /dev/null +++ b/docs/0.6/pyrra/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.6/pyrra/v1alpha1/ +--- + +# pyrra.v1alpha1 + + + +* [serviceLevelObjective](serviceLevelObjective.md) \ No newline at end of file diff --git a/docs/0.6/pyrra/v1alpha1/serviceLevelObjective.md b/docs/0.6/pyrra/v1alpha1/serviceLevelObjective.md new file mode 100644 index 0000000..ca91871 --- /dev/null +++ b/docs/0.6/pyrra/v1alpha1/serviceLevelObjective.md @@ -0,0 +1,404 @@ +--- +permalink: /0.6/pyrra/v1alpha1/serviceLevelObjective/ +--- + +# pyrra.v1alpha1.serviceLevelObjective + +"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDescription(description)`](#fn-specwithdescription) + * [`fn withTarget(target)`](#fn-specwithtarget) + * [`fn withWindow(window)`](#fn-specwithwindow) + * [`obj spec.alerting`](#obj-specalerting) + * [`fn withDisabled(disabled)`](#fn-specalertingwithdisabled) + * [`fn withName(name)`](#fn-specalertingwithname) + * [`obj spec.indicator`](#obj-specindicator) + * [`obj spec.indicator.bool_gauge`](#obj-specindicatorbool_gauge) + * [`fn withGrouping(grouping)`](#fn-specindicatorbool_gaugewithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorbool_gaugewithgroupingmixin) + * [`fn withMetric(metric)`](#fn-specindicatorbool_gaugewithmetric) + * [`obj spec.indicator.latency`](#obj-specindicatorlatency) + * [`fn withGrouping(grouping)`](#fn-specindicatorlatencywithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorlatencywithgroupingmixin) + * [`obj spec.indicator.latency.success`](#obj-specindicatorlatencysuccess) + * [`fn withMetric(metric)`](#fn-specindicatorlatencysuccesswithmetric) + * [`obj spec.indicator.latency.total`](#obj-specindicatorlatencytotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencytotalwithmetric) + * [`obj spec.indicator.ratio`](#obj-specindicatorratio) + * [`fn withGrouping(grouping)`](#fn-specindicatorratiowithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorratiowithgroupingmixin) + * [`obj spec.indicator.ratio.errors`](#obj-specindicatorratioerrors) + * [`fn withMetric(metric)`](#fn-specindicatorratioerrorswithmetric) + * [`obj spec.indicator.ratio.total`](#obj-specindicatorratiototal) + * [`fn withMetric(metric)`](#fn-specindicatorratiototalwithmetric) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceLevelObjective + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective." + +### fn spec.withDescription + +```ts +withDescription(description) +``` + +"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service." + +### fn spec.withTarget + +```ts +withTarget(target) +``` + +"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245" + +### fn spec.withWindow + +```ts +withWindow(window) +``` + +"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d." + +## obj spec.alerting + +"Alerting customizes the alerting rules generated by Pyrra." + +### fn spec.alerting.withDisabled + +```ts +withDisabled(disabled) +``` + +"Disabled is used to disable the generation of alerts. Recording rules are still generated." + +### fn spec.alerting.withName + +```ts +withName(name) +``` + +"Name is used as the name of the alert generated by Pyrra. Defaults to \"ErrorBudgetBurn\"." + +## obj spec.indicator + +"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service." + +## obj spec.indicator.bool_gauge + +"BoolGauge is the indicator that measures wheter a boolean gauge is successul." + +### fn spec.indicator.bool_gauge.withGrouping + +```ts +withGrouping(grouping) +``` + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.bool_gauge.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Total is the metric that returns how many requests there are in total." + +**Note:** This function appends passed data to existing values + +### fn spec.indicator.bool_gauge.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency + +"Latency is the indicator that measures a certain percentage to be fast than." + +### fn spec.indicator.latency.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.latency.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.latency.success + +"Success is the metric that returns how many errors there are." + +### fn spec.indicator.latency.success.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latency.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio + +"Ratio is the indicator that measures against errors / total events." + +### fn spec.indicator.ratio.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.ratio.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.ratio.errors + +"Errors is the metric that returns how many errors there are." + +### fn spec.indicator.ratio.errors.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.ratio.total.withMetric + +```ts +withMetric(metric) +``` + diff --git a/docs/0.7/README.md b/docs/0.7/README.md new file mode 100644 index 0000000..0a31e01 --- /dev/null +++ b/docs/0.7/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.7/ +--- + +# pyrra + +```jsonnet +local pyrra = import "github.com/jsonnet-libs/pyrra-libsonnet/0.7/main.libsonnet" +``` + + + +* [pyrra](pyrra/index.md) \ No newline at end of file diff --git a/docs/0.7/pyrra/index.md b/docs/0.7/pyrra/index.md new file mode 100644 index 0000000..adea77f --- /dev/null +++ b/docs/0.7/pyrra/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.7/pyrra/ +--- + +# pyrra + + + +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.7/pyrra/v1alpha1/index.md b/docs/0.7/pyrra/v1alpha1/index.md new file mode 100644 index 0000000..964cc47 --- /dev/null +++ b/docs/0.7/pyrra/v1alpha1/index.md @@ -0,0 +1,9 @@ +--- +permalink: /0.7/pyrra/v1alpha1/ +--- + +# pyrra.v1alpha1 + + + +* [serviceLevelObjective](serviceLevelObjective.md) \ No newline at end of file diff --git a/docs/0.7/pyrra/v1alpha1/serviceLevelObjective.md b/docs/0.7/pyrra/v1alpha1/serviceLevelObjective.md new file mode 100644 index 0000000..dc88f03 --- /dev/null +++ b/docs/0.7/pyrra/v1alpha1/serviceLevelObjective.md @@ -0,0 +1,470 @@ +--- +permalink: /0.7/pyrra/v1alpha1/serviceLevelObjective/ +--- + +# pyrra.v1alpha1.serviceLevelObjective + +"ServiceLevelObjective is the Schema for the ServiceLevelObjectives API." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withDescription(description)`](#fn-specwithdescription) + * [`fn withTarget(target)`](#fn-specwithtarget) + * [`fn withWindow(window)`](#fn-specwithwindow) + * [`obj spec.alerting`](#obj-specalerting) + * [`fn withAbsent(absent)`](#fn-specalertingwithabsent) + * [`fn withBurnrates(burnrates)`](#fn-specalertingwithburnrates) + * [`fn withDisabled(disabled)`](#fn-specalertingwithdisabled) + * [`fn withName(name)`](#fn-specalertingwithname) + * [`obj spec.indicator`](#obj-specindicator) + * [`obj spec.indicator.bool_gauge`](#obj-specindicatorbool_gauge) + * [`fn withGrouping(grouping)`](#fn-specindicatorbool_gaugewithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorbool_gaugewithgroupingmixin) + * [`fn withMetric(metric)`](#fn-specindicatorbool_gaugewithmetric) + * [`obj spec.indicator.latency`](#obj-specindicatorlatency) + * [`fn withGrouping(grouping)`](#fn-specindicatorlatencywithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorlatencywithgroupingmixin) + * [`obj spec.indicator.latency.success`](#obj-specindicatorlatencysuccess) + * [`fn withMetric(metric)`](#fn-specindicatorlatencysuccesswithmetric) + * [`obj spec.indicator.latency.total`](#obj-specindicatorlatencytotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencytotalwithmetric) + * [`obj spec.indicator.latencyNative`](#obj-specindicatorlatencynative) + * [`fn withGrouping(grouping)`](#fn-specindicatorlatencynativewithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorlatencynativewithgroupingmixin) + * [`fn withLatency(latency)`](#fn-specindicatorlatencynativewithlatency) + * [`obj spec.indicator.latencyNative.total`](#obj-specindicatorlatencynativetotal) + * [`fn withMetric(metric)`](#fn-specindicatorlatencynativetotalwithmetric) + * [`obj spec.indicator.ratio`](#obj-specindicatorratio) + * [`fn withGrouping(grouping)`](#fn-specindicatorratiowithgrouping) + * [`fn withGroupingMixin(grouping)`](#fn-specindicatorratiowithgroupingmixin) + * [`obj spec.indicator.ratio.errors`](#obj-specindicatorratioerrors) + * [`fn withMetric(metric)`](#fn-specindicatorratioerrorswithmetric) + * [`obj spec.indicator.ratio.total`](#obj-specindicatorratiototal) + * [`fn withMetric(metric)`](#fn-specindicatorratiototalwithmetric) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceLevelObjective + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +withAnnotations(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +### fn metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(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. More info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn metadata.withClusterName + +```ts +withClusterName(clusterName) +``` + +"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + +### fn metadata.withCreationTimestamp + +```ts +withCreationTimestamp(creationTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withDeletionGracePeriodSeconds + +```ts +withDeletionGracePeriodSeconds(deletionGracePeriodSeconds) +``` + +"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only." + +### fn metadata.withDeletionTimestamp + +```ts +withDeletionTimestamp(deletionTimestamp) +``` + +"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers." + +### fn metadata.withFinalizers + +```ts +withFinalizers(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +### fn metadata.withFinalizersMixin + +```ts +withFinalizersMixin(finalizers) +``` + +"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list." + +**Note:** This function appends passed data to existing values + +### fn metadata.withGenerateName + +```ts +withGenerateName(generateName) +``` + +"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency" + +### fn metadata.withGeneration + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +### fn metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + +### fn metadata.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + +### fn metadata.withOwnerReferences + +```ts +withOwnerReferences(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +### fn metadata.withOwnerReferencesMixin + +```ts +withOwnerReferencesMixin(ownerReferences) +``` + +"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller." + +**Note:** This function appends passed data to existing values + +### fn metadata.withResourceVersion + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +withSelfLink(selfLink) +``` + +"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release." + +### fn metadata.withUid + +```ts +withUid(uid) +``` + +"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + +## obj spec + +"ServiceLevelObjectiveSpec defines the desired state of ServiceLevelObjective." + +### fn spec.withDescription + +```ts +withDescription(description) +``` + +"Description describes the ServiceLevelObjective in more detail and gives extra context for engineers that might not directly work on the service." + +### fn spec.withTarget + +```ts +withTarget(target) +``` + +"Target is a string that's casted to a float64 between 0 - 100. It represents the desired availability of the service in the given window. float64 are not supported: https://github.com/kubernetes-sigs/controller-tools/issues/245" + +### fn spec.withWindow + +```ts +withWindow(window) +``` + +"Window within which the Target is supposed to be kept. Usually something like 1d, 7d or 28d." + +## obj spec.alerting + +"Alerting customizes the alerting rules generated by Pyrra." + +### fn spec.alerting.withAbsent + +```ts +withAbsent(absent) +``` + + + +### fn spec.alerting.withBurnrates + +```ts +withBurnrates(burnrates) +``` + + + +### fn spec.alerting.withDisabled + +```ts +withDisabled(disabled) +``` + +"Disabled is used to disable the generation of alerts. Recording rules are still generated." + +### fn spec.alerting.withName + +```ts +withName(name) +``` + +"Name is used as the name of the alert generated by Pyrra. Defaults to \"ErrorBudgetBurn\"." + +## obj spec.indicator + +"ServiceLevelIndicator is the underlying data source that indicates how the service is doing. This will be a Prometheus metric with specific selectors for your service." + +## obj spec.indicator.bool_gauge + +"BoolGauge is the indicator that measures whether a boolean gauge is successful." + +### fn spec.indicator.bool_gauge.withGrouping + +```ts +withGrouping(grouping) +``` + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.bool_gauge.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Total is the metric that returns how many requests there are in total." + +**Note:** This function appends passed data to existing values + +### fn spec.indicator.bool_gauge.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency + +"Latency is the indicator that measures a certain percentage to be faster than the expected latency." + +### fn spec.indicator.latency.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.latency.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.latency.success + +"Success is the metric that returns how many errors there are." + +### fn spec.indicator.latency.success.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latency.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latency.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.latencyNative + +"LatencyNative is the indicator that measures a certain percentage to be faster than the expected latency. This uses the new native histograms in Prometheus." + +### fn spec.indicator.latencyNative.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.latencyNative.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +### fn spec.indicator.latencyNative.withLatency + +```ts +withLatency(latency) +``` + +"Latency the requests should be faster than." + +## obj spec.indicator.latencyNative.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.latencyNative.total.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio + +"Ratio is the indicator that measures against errors / total events." + +### fn spec.indicator.ratio.withGrouping + +```ts +withGrouping(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +### fn spec.indicator.ratio.withGroupingMixin + +```ts +withGroupingMixin(grouping) +``` + +"Grouping allows an SLO to be defined for many SLI at once, like HTTP handlers for example." + +**Note:** This function appends passed data to existing values + +## obj spec.indicator.ratio.errors + +"Errors is the metric that returns how many errors there are." + +### fn spec.indicator.ratio.errors.withMetric + +```ts +withMetric(metric) +``` + + + +## obj spec.indicator.ratio.total + +"Total is the metric that returns how many requests there are in total." + +### fn spec.indicator.ratio.total.withMetric + +```ts +withMetric(metric) +``` + diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..cb8a116 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# pyrra Jsonnet library + +This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). + +- [0.1](0.1/README.md) +- [0.2](0.2/README.md) +- [0.3](0.3/README.md) +- [0.4](0.4/README.md) +- [0.5](0.5/README.md) +- [0.6](0.6/README.md) +- [0.7](0.7/README.md) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..ed54bbf --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,48 @@ +/* Menu */ +/* Decapitalize menu items, Mkdocs capilizes by default and can't be configured */ +nav nav .md-nav__link .md-ellipsis::first-letter { text-transform: lowercase } + +/* TOC */ +/* Don't wrap TOC links with spaces */ +.md-sidebar--secondary .md-nav__item { white-space: nowrap } +/* Scroll horizontal to make them accessible */ +.md-sidebar--secondary .md-sidebar__scrollwrap { overflow-x: auto } + +/* Code */ +/* Make codeblocks stand out */ +.md-typeset pre>code { border-left: 0.2rem solid var(--md-accent-fg-color) } + +/* Headings */ +/* Hide headings for functions but don't remove them, they function as deeplink targets */ +h2[id^="fn-"], +h3[id^="fn-"], +h4[id^="fn-"], +h5[id^="fn-"], +h6[id^="fn-"], +h7[id^="fn-"], +h8[id^="fn-"], +h9[id^="fn-"] { + visibility: hidden; + width: 0; + height: 0; + padding: 0; + margin: 0; +} + +/* Parameters */ +/* Format 'PARAMETERS' after highlight (div.highlight) */ +/* Match first paragraph (p) but only if it is followed by an unsorted list (ul) */ +article.md-content__inner.md-typeset div.highlight+p:has(+ul) { + padding-left: 1em; + margin-top: 0; + margin-bottom: 0; +} +/* Match first unsorted list (ul) after paragraph (p) */ +article.md-content__inner.md-typeset div.highlight+p+ul { + padding-left: 1em; + margin-top:0; +} +article.md-content__inner.md-typeset div.highlight+p+ul li { + margin-top: 0; + margin-bottom: 0; +} diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..4927c99 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,38 @@ +"edit_uri": "" +"extra_css": + - "stylesheets/extra.css" +"markdown_extensions": + - "pymdownx.highlight" + - "pymdownx.superfences" + - "mdx_truly_sane_lists": + "nested_indent": 2 + "truly_sane": true +"plugins": + - "search": + "separator": "[\\s\\-\\.]+" + - "minify": + "minify_html": true +"repo_name": "jsonnet-libs/pyrra-libsonnet" +"repo_url": "https://github.com/jsonnet-libs/pyrra-libsonnet" +"site_name": "pyrra jsonnet library" +"site_url": "https://jsonnet-libs.github.io/pyrra-libsonnet" +"theme": + "features": + - "navigation.tabs" + - "navigation.indexes" + "name": "material" + "palette": + - "accent": "indigo" + "media": "(prefers-color-scheme: light)" + "primary": "indigo" + "scheme": "default" + "toggle": + "icon": "material/toggle-switch-off-outline" + "name": "Switch to dark mode" + - "accent": "red" + "media": "(prefers-color-scheme: dark)" + "primary": "red" + "scheme": "slate" + "toggle": + "icon": "material/toggle-switch" + "name": "Switch to light mode" \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c790bf2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,14 @@ +# mkdocs +mkdocs>=1.3.0 + +# To limit search to a subset +mkdocs-exclude-search>=0.5 + +# To minify the HTML +mkdocs-minify-plugin>=0.3 + +# Include the theme +mkdocs-material>=7.1.6 + +# Deal with list indent of 2 spaces +mdx-truly-sane-lists>=1.3