diff --git a/Cargo.lock b/Cargo.lock index 67ee958f..563b1dc2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -200,7 +200,7 @@ checksum = "0952808a6c2afd1aa8947271f3a60f1a6763c7b912d210184c5149b5cf147247" [[package]] name = "apibara-cli" -version = "0.4.2" +version = "0.5.0" dependencies = [ "apibara-core", "apibara-observability", @@ -212,6 +212,7 @@ dependencies = [ "colored", "dirs", "error-stack", + "float-cmp", "futures 0.3.30", "octocrab", "reqwest", diff --git a/charts/operator/.helmignore b/charts/operator/.helmignore new file mode 100644 index 00000000..0e8a0eb3 --- /dev/null +++ b/charts/operator/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/operator/Chart.yaml b/charts/operator/Chart.yaml new file mode 100644 index 00000000..639e4f60 --- /dev/null +++ b/charts/operator/Chart.yaml @@ -0,0 +1,9 @@ +apiVersion: v2 +name: operator +description: The Apibara operator for Kubernetes +type: application +version: 0.1.0 +appVersion: "0.2.2" +home: https://www.apibara.com +sources: + - https://github.com/apibara/dna/tree/main/charts/operator diff --git a/charts/operator/README.md b/charts/operator/README.md new file mode 100644 index 00000000..585007a8 --- /dev/null +++ b/charts/operator/README.md @@ -0,0 +1,41 @@ +# Apibara Operator + +The Apibara Operator is a Kubernetes operator to deploy indexers. + +## Usage + +The chart is published to an OCI Helm repository. + +Inspect the chart with the `helm show` command: + +``` +$ helm show readme oci://quay.io/apibara-charts/operator +--- +Pulled: quay.io/apibara-charts/operator:0.1.0 +Digest: sha256:a248767bcfbb2973b616052dcc38b791f1b6ff13f2db40b61951183f85c0729e +# Apibara Operator + +The Apibara Operator is a Kubernetes operator to deploy indexers. +``` + +Install the chart with `helm install`. + +``` +$ helm install capy oci://quay.io/apibara-charts/operator +--- +Pulled: quay.io/apibara-charts/operator:0.1.0 +Digest: sha256:a248767bcfbb2973b616052dcc38b791f1b6ff13f2db40b61951183f85c0729e +NAME: capy +LAST DEPLOYED: Fri May 10 21:00:30 2024 +NAMESPACE: default +STATUS: deployed +REVISION: 1 +TEST SUITE: None +NOTES: +capy-operator has been installed. Check its status by running: + + kubectl --namespace default get pods + +``` + +Customize the release using `values.yaml` as usual. diff --git a/charts/operator/crds/custom-resource-definitions.yaml b/charts/operator/crds/custom-resource-definitions.yaml new file mode 100644 index 00000000..bf826f3c --- /dev/null +++ b/charts/operator/crds/custom-resource-definitions.yaml @@ -0,0 +1,1373 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: indexers.apibara.com +spec: + group: apibara.com + names: + categories: [] + kind: Indexer + plural: indexers + shortNames: + - indexer + singular: indexer + scope: Namespaced + versions: + - additionalPrinterColumns: + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + - jsonPath: .status.phase + name: Status + type: string + - jsonPath: .status.instanceName + name: Instance + type: string + - jsonPath: .status.restartCount + name: Restarts + type: number + name: v1alpha2 + schema: + openAPIV3Schema: + description: Auto-generated derived type for IndexerSpec via `CustomResource` + properties: + spec: + description: Run an indexer. + properties: + env: + description: List of environment variables to set in the indexer container. + items: + description: EnvVar represents an environment variable present in a Container. + properties: + name: + description: Name of the environment variable. Must be a C_IDENTIFIER. + type: string + value: + description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".' + type: string + valueFrom: + description: Source for the environment variable's value. Cannot be used if value is not empty. + properties: + configMapKeyRef: + description: Selects a key of a ConfigMap. + properties: + key: + description: The key to select. + type: string + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + optional: + description: Specify whether the ConfigMap or its key must be defined + type: boolean + required: + - key + type: object + fieldRef: + description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['''']`, `metadata.annotations['''']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.' + properties: + apiVersion: + description: Version of the schema the FieldPath is written in terms of, defaults to "v1". + type: string + fieldPath: + description: Path of the field to select in the specified API version. + type: string + required: + - fieldPath + type: object + resourceFieldRef: + description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.' + properties: + containerName: + description: 'Container name: required for volumes, optional for env vars' + type: string + divisor: + description: Specifies the output format of the exposed resources, defaults to "1" + type: string + resource: + description: 'Required: resource to select' + type: string + required: + - resource + type: object + secretKeyRef: + description: Selects a key of a secret in the pod's namespace + properties: + key: + description: The key of the secret to select from. Must be a valid secret key. + type: string + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + optional: + description: Specify whether the Secret or its key must be defined + type: boolean + required: + - key + type: object + type: object + required: + - name + type: object + nullable: true + type: array + sink: + anyOf: + - required: + - type + - required: + - image + description: Sink to run. + properties: + args: + description: Arguments passed to the sink. + items: + type: string + nullable: true + type: array + image: + type: string + script: + description: Path to the script to run. + type: string + type: + type: string + required: + - script + type: object + source: + description: Indexer source code. + oneOf: + - required: + - gitHub + - required: + - volume + properties: + gitHub: + description: Clone the indexer repository from GitHub. + properties: + accessTokenEnvVar: + description: Environment variable containing the GitHub access token. + nullable: true + type: string + gitCleanFlags: + description: Additional flags to pass to `git clean`. + nullable: true + type: string + gitCloneFlags: + description: Additional flags to pass to `git clone`. + nullable: true + type: string + owner: + description: GitHub repository owner, e.g. `my-org`. + type: string + repo: + description: GitHub repository name, e.g. `my-indexer`. + type: string + revision: + description: Git revision, e.g. `main` or `a746ab`. + type: string + subpath: + description: Run the indexer from the specified subpath of the repository, e.g. `/packages/indexer`. + nullable: true + type: string + required: + - owner + - repo + - revision + type: object + volume: + description: Use source code from a mounted volume. + properties: + path: + description: |- + Path to the indexer source code, e.g. `/myvolume`. + + Use this option with the `volumes` field to mount a volume containing the indexer source code. + type: string + required: + - path + type: object + type: object + volumes: + description: List of volumes that can be mounted by containers belonging to the indexer. + items: + properties: + volume: + description: Volume to mount. + properties: + awsElasticBlockStore: + description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' + properties: + fsType: + description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' + type: string + partition: + description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).' + format: int32 + type: integer + readOnly: + description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' + type: boolean + volumeID: + description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' + type: string + required: + - volumeID + type: object + azureDisk: + description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + properties: + cachingMode: + description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.' + type: string + diskName: + description: diskName is the Name of the data disk in the blob storage + type: string + diskURI: + description: diskURI is the URI of data disk in the blob storage + type: string + fsType: + description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + type: string + kind: + description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared' + type: string + readOnly: + description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + type: boolean + required: + - diskName + - diskURI + type: object + azureFile: + description: azureFile represents an Azure File Service mount on the host and bind mount to the pod. + properties: + readOnly: + description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + type: boolean + secretName: + description: secretName is the name of secret that contains Azure Storage Account Name and Key + type: string + shareName: + description: shareName is the azure share Name + type: string + required: + - secretName + - shareName + type: object + cephfs: + description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + properties: + monitors: + description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' + items: + type: string + type: array + path: + description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /' + type: string + readOnly: + description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' + type: boolean + secretFile: + description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' + type: string + secretRef: + description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + user: + description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' + type: string + required: + - monitors + type: object + cinder: + description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md' + properties: + fsType: + description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md' + type: string + readOnly: + description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md' + type: boolean + secretRef: + description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.' + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + volumeID: + description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md' + type: string + required: + - volumeID + type: object + configMap: + description: configMap represents a configMap that should populate this volume + properties: + defaultMode: + description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + items: + description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + items: + description: Maps a string key to a path within a volume. + properties: + key: + description: key is the key to project. + type: string + mode: + description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + path: + description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + type: string + required: + - key + - path + type: object + type: array + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + optional: + description: optional specify whether the ConfigMap or its keys must be defined + type: boolean + type: object + csi: + description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + properties: + driver: + description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. + type: string + fsType: + description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. + type: string + nodePublishSecretRef: + description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + readOnly: + description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). + type: boolean + volumeAttributes: + additionalProperties: + type: string + description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. + type: object + required: + - driver + type: object + downwardAPI: + description: downwardAPI represents downward API about the pod that should populate this volume + properties: + defaultMode: + description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + items: + description: Items is a list of downward API volume file + items: + description: DownwardAPIVolumeFile represents information to create the file containing the pod field + properties: + fieldRef: + description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.' + properties: + apiVersion: + description: Version of the schema the FieldPath is written in terms of, defaults to "v1". + type: string + fieldPath: + description: Path of the field to select in the specified API version. + type: string + required: + - fieldPath + type: object + mode: + description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + path: + description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..''' + type: string + resourceFieldRef: + description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.' + properties: + containerName: + description: 'Container name: required for volumes, optional for env vars' + type: string + divisor: + description: Specifies the output format of the exposed resources, defaults to "1" + type: string + resource: + description: 'Required: resource to select' + type: string + required: + - resource + type: object + required: + - path + type: object + type: array + type: object + emptyDir: + description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir' + properties: + medium: + description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir' + type: string + sizeLimit: + description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir' + type: string + type: object + ephemeral: + description: |- + ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. + + Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity + tracking are needed, + c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through + a PersistentVolumeClaim (see EphemeralVolumeSource for more + information on the connection between this volume type + and PersistentVolumeClaim). + + Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. + + Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. + + A pod can use both types of ephemeral volumes and persistent volumes at the same time. + properties: + volumeClaimTemplate: + description: |- + Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). + + An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. + + This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. + + Required, must not be nil. + properties: + metadata: + description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. + properties: + annotations: + additionalProperties: + type: string + description: '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' + type: object + creationTimestamp: + description: |- + CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. + + Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + format: date-time + type: string + deletionGracePeriodSeconds: + description: 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. + format: int64 + type: integer + deletionTimestamp: + description: |- + DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. + + Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + format: date-time + type: string + finalizers: + description: 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. + items: + type: string + type: array + generateName: + description: |- + 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. + + If this field is specified and the generated name exists, the server will return a 409. + + Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency + type: string + generation: + description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. + format: int64 + type: integer + labels: + additionalProperties: + type: string + description: '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' + type: object + managedFields: + description: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. + items: + description: ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. + properties: + apiVersion: + description: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. + type: string + fieldsType: + description: 'FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"' + type: string + fieldsV1: + description: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + type: object + manager: + description: Manager is an identifier of the workflow managing these fields. + type: string + operation: + description: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. + type: string + subresource: + description: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. + type: string + time: + description: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. + format: date-time + type: string + type: object + type: array + name: + description: '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' + type: string + namespace: + description: |- + 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. + + Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces + type: string + ownerReferences: + description: 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. + items: + description: OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. + properties: + apiVersion: + description: API version of the referent. + type: string + blockOwnerDeletion: + description: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. + type: boolean + controller: + description: If true, this reference points to the managing controller. + type: boolean + kind: + description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + type: string + name: + description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names' + type: string + uid: + description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids' + type: string + required: + - apiVersion + - kind + - name + - uid + type: object + type: array + resourceVersion: + description: |- + 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. + + Populated 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 + type: string + selfLink: + description: 'Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.' + type: string + uid: + description: |- + 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. + + Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + type: string + type: object + spec: + description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. + properties: + accessModes: + description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1' + items: + type: string + type: array + dataSource: + description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.' + properties: + apiGroup: + description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + type: string + kind: + description: Kind is the type of resource being referenced + type: string + name: + description: Name is the name of resource being referenced + type: string + required: + - kind + - name + type: object + dataSourceRef: + description: |- + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef + allows any non-core object, as well as PersistentVolumeClaim objects. + * While dataSource ignores disallowed values (dropping them), dataSourceRef + preserves all values, and generates an error if a disallowed value is + specified. + * While dataSource only allows local objects, dataSourceRef allows objects + in any namespaces. + (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + properties: + apiGroup: + description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + type: string + kind: + description: Kind is the type of resource being referenced + type: string + name: + description: Name is the name of resource being referenced + type: string + namespace: + description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + type: string + required: + - kind + - name + type: object + resources: + description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources' + properties: + claims: + description: |- + Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. + + This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. + + This field is immutable. It can only be set for containers. + items: + description: ResourceClaim references one entry in PodSpec.ResourceClaims. + properties: + name: + description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. + type: string + required: + - name + type: object + type: array + limits: + additionalProperties: + description: "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` ::= \n\n\t(Note that may be empty, from the \"\" case in .)\n\n ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= \"+\" | \"-\" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n ::= \"e\" | \"E\" ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation." + type: string + description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + type: object + requests: + additionalProperties: + description: "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` ::= \n\n\t(Note that may be empty, from the \"\" case in .)\n\n ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= \"+\" | \"-\" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n ::= \"e\" | \"E\" ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation." + type: string + description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + type: object + type: object + selector: + description: selector is a label query over volumes to consider for binding. + properties: + matchExpressions: + description: matchExpressions is a list of label selector requirements. The requirements are ANDed. + items: + description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + properties: + key: + description: key is the label key that the selector applies to. + type: string + operator: + description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. + type: string + values: + description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + items: + type: string + type: array + required: + - key + - operator + type: object + type: array + matchLabels: + additionalProperties: + type: string + description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. + type: object + type: object + storageClassName: + description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1' + type: string + volumeMode: + description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. + type: string + volumeName: + description: volumeName is the binding reference to the PersistentVolume backing this claim. + type: string + type: object + required: + - spec + type: object + type: object + fc: + description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + properties: + fsType: + description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + type: string + lun: + description: 'lun is Optional: FC target lun number' + format: int32 + type: integer + readOnly: + description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.' + type: boolean + targetWWNs: + description: 'targetWWNs is Optional: FC target worldwide names (WWNs)' + items: + type: string + type: array + wwids: + description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.' + items: + type: string + type: array + type: object + flexVolume: + description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + properties: + driver: + description: driver is the name of the driver to use for this volume. + type: string + fsType: + description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + type: string + options: + additionalProperties: + type: string + description: 'options is Optional: this field holds extra command options if any.' + type: object + readOnly: + description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.' + type: boolean + secretRef: + description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.' + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + required: + - driver + type: object + flocker: + description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + properties: + datasetName: + description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated + type: string + datasetUUID: + description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset + type: string + type: object + gcePersistentDisk: + description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' + properties: + fsType: + description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' + type: string + partition: + description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' + format: int32 + type: integer + pdName: + description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' + type: string + readOnly: + description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' + type: boolean + required: + - pdName + type: object + gitRepo: + description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.' + properties: + directory: + description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + type: string + repository: + description: repository is the URL + type: string + revision: + description: revision is the commit hash for the specified revision. + type: string + required: + - repository + type: object + glusterfs: + description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md' + properties: + endpoints: + description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod' + type: string + path: + description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod' + type: string + readOnly: + description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod' + type: boolean + required: + - endpoints + - path + type: object + hostPath: + description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath' + properties: + path: + description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath' + type: string + type: + description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath' + type: string + required: + - path + type: object + iscsi: + description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md' + properties: + chapAuthDiscovery: + description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication + type: boolean + chapAuthSession: + description: chapAuthSession defines whether support iSCSI Session CHAP authentication + type: boolean + fsType: + description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi' + type: string + initiatorName: + description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + type: string + iqn: + description: iqn is the target iSCSI Qualified Name. + type: string + iscsiInterface: + description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + type: string + lun: + description: lun represents iSCSI Target Lun number. + format: int32 + type: integer + portals: + description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + items: + type: string + type: array + readOnly: + description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + type: boolean + secretRef: + description: secretRef is the CHAP Secret for iSCSI target and initiator authentication + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + targetPortal: + description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + type: string + required: + - iqn + - lun + - targetPortal + type: object + name: + description: 'name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + nfs: + description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' + properties: + path: + description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' + type: string + readOnly: + description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' + type: boolean + server: + description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' + type: string + required: + - path + - server + type: object + persistentVolumeClaim: + description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims' + properties: + claimName: + description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims' + type: string + readOnly: + description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false. + type: boolean + required: + - claimName + type: object + photonPersistentDisk: + description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + properties: + fsType: + description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + type: string + pdID: + description: pdID is the ID that identifies Photon Controller persistent disk + type: string + required: + - pdID + type: object + portworxVolume: + description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine + properties: + fsType: + description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + type: string + readOnly: + description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + type: boolean + volumeID: + description: volumeID uniquely identifies a Portworx volume + type: string + required: + - volumeID + type: object + projected: + description: projected items for all in one resources secrets, configmaps, and downward API + properties: + defaultMode: + description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + format: int32 + type: integer + sources: + description: sources is the list of volume projections + items: + description: Projection that may be projected along with other supported volume types + properties: + configMap: + description: configMap information about the configMap data to project + properties: + items: + description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + items: + description: Maps a string key to a path within a volume. + properties: + key: + description: key is the key to project. + type: string + mode: + description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + path: + description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + type: string + required: + - key + - path + type: object + type: array + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + optional: + description: optional specify whether the ConfigMap or its keys must be defined + type: boolean + type: object + downwardAPI: + description: downwardAPI information about the downwardAPI data to project + properties: + items: + description: Items is a list of DownwardAPIVolume file + items: + description: DownwardAPIVolumeFile represents information to create the file containing the pod field + properties: + fieldRef: + description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.' + properties: + apiVersion: + description: Version of the schema the FieldPath is written in terms of, defaults to "v1". + type: string + fieldPath: + description: Path of the field to select in the specified API version. + type: string + required: + - fieldPath + type: object + mode: + description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + path: + description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..''' + type: string + resourceFieldRef: + description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.' + properties: + containerName: + description: 'Container name: required for volumes, optional for env vars' + type: string + divisor: + description: Specifies the output format of the exposed resources, defaults to "1" + type: string + resource: + description: 'Required: resource to select' + type: string + required: + - resource + type: object + required: + - path + type: object + type: array + type: object + secret: + description: secret information about the secret data to project + properties: + items: + description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + items: + description: Maps a string key to a path within a volume. + properties: + key: + description: key is the key to project. + type: string + mode: + description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + path: + description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + type: string + required: + - key + - path + type: object + type: array + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + optional: + description: optional field specify whether the Secret or its key must be defined + type: boolean + type: object + serviceAccountToken: + description: serviceAccountToken is information about the serviceAccountToken data to project + properties: + audience: + description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. + type: string + expirationSeconds: + description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. + format: int64 + type: integer + path: + description: path is the path relative to the mount point of the file to project the token into. + type: string + required: + - path + type: object + type: object + type: array + type: object + quobyte: + description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime + properties: + group: + description: group to map volume access to Default is no group + type: string + readOnly: + description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. + type: boolean + registry: + description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes + type: string + tenant: + description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin + type: string + user: + description: user to map volume access to Defaults to serivceaccount user + type: string + volume: + description: volume is a string that references an already created Quobyte volume by name. + type: string + required: + - registry + - volume + type: object + rbd: + description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md' + properties: + fsType: + description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd' + type: string + image: + description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' + type: string + keyring: + description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' + type: string + monitors: + description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' + items: + type: string + type: array + pool: + description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' + type: string + readOnly: + description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' + type: boolean + secretRef: + description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + user: + description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' + type: string + required: + - image + - monitors + type: object + scaleIO: + description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + properties: + fsType: + description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". + type: string + gateway: + description: gateway is the host address of the ScaleIO API Gateway. + type: string + protectionDomain: + description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. + type: string + readOnly: + description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + type: boolean + secretRef: + description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + sslEnabled: + description: sslEnabled Flag enable/disable SSL communication with Gateway, default false + type: boolean + storageMode: + description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + type: string + storagePool: + description: storagePool is the ScaleIO Storage Pool associated with the protection domain. + type: string + system: + description: system is the name of the storage system as configured in ScaleIO. + type: string + volumeName: + description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. + type: string + required: + - gateway + - secretRef + - system + type: object + secret: + description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret' + properties: + defaultMode: + description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + items: + description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + items: + description: Maps a string key to a path within a volume. + properties: + key: + description: key is the key to project. + type: string + mode: + description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.' + format: int32 + type: integer + path: + description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + type: string + required: + - key + - path + type: object + type: array + optional: + description: optional field specify whether the Secret or its keys must be defined + type: boolean + secretName: + description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret' + type: string + type: object + storageos: + description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + properties: + fsType: + description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + type: string + readOnly: + description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + type: boolean + secretRef: + description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. + properties: + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + type: object + volumeName: + description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + type: string + volumeNamespace: + description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + type: string + type: object + vsphereVolume: + description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + properties: + fsType: + description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + type: string + storagePolicyID: + description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + type: string + storagePolicyName: + description: storagePolicyName is the storage Policy Based Management (SPBM) profile name. + type: string + volumePath: + description: volumePath is the path that identifies vSphere volume vmdk + type: string + required: + - volumePath + type: object + required: + - name + type: object + volumeMount: + description: Volume mount specification. + properties: + mountPath: + description: Path within the container at which the volume should be mounted. Must not contain ':'. + type: string + mountPropagation: + description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + type: string + name: + description: This must match the Name of a Volume. + type: string + readOnly: + description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + type: boolean + subPath: + description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + type: string + subPathExpr: + description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + type: string + required: + - mountPath + - name + type: object + required: + - volume + - volumeMount + type: object + nullable: true + type: array + required: + - sink + - source + type: object + status: + description: Most recent status of the indexer. + nullable: true + properties: + conditions: + description: Conditions of the indexer. + items: + description: Condition contains details for one aspect of the current state of this API Resource. + properties: + lastTransitionTime: + description: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. + format: date-time + type: string + message: + description: message is a human readable message indicating details about the transition. This may be an empty string. + type: string + observedGeneration: + description: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. + format: int64 + type: integer + reason: + description: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. + type: string + status: + description: status of the condition, one of True, False, Unknown. + type: string + type: + description: type of condition in CamelCase or in foo.example.com/CamelCase. + type: string + required: + - lastTransitionTime + - message + - reason + - status + - type + type: object + nullable: true + type: array + instanceName: + description: The name of the container running the indexer. + nullable: true + type: string + phase: + description: Current phase of the indexer. + nullable: true + type: string + podCreated: + description: Creation timestamp of the indexer's pod. + format: date-time + nullable: true + type: string + restartCount: + description: Number of times the indexer container has restarted. + format: int32 + nullable: true + type: integer + statusServiceName: + description: Service name exposing the indexer's status. + nullable: true + type: string + type: object + required: + - spec + title: Indexer + type: object + served: true + storage: true + subresources: + status: {} + diff --git a/charts/operator/templates/NOTES.txt b/charts/operator/templates/NOTES.txt new file mode 100644 index 00000000..928d9b12 --- /dev/null +++ b/charts/operator/templates/NOTES.txt @@ -0,0 +1,3 @@ +{{ template "operator.fullname" . }} has been installed. Check its status by running: + + kubectl --namespace {{ template "operator.namespace" . }} get pods diff --git a/charts/operator/templates/_helpers.tpl b/charts/operator/templates/_helpers.tpl new file mode 100644 index 00000000..ecfe3da3 --- /dev/null +++ b/charts/operator/templates/_helpers.tpl @@ -0,0 +1,69 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "operator.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Namespace where to install the operator. +*/}} +{{- define "operator.namespace" -}} +{{- default .Release.Namespace .Values.namespace -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "operator.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "operator.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "operator.labels" -}} +helm.sh/chart: {{ include "operator.chart" . }} +{{ include "operator.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "operator.selectorLabels" -}} +app.kubernetes.io/name: {{ include "operator.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "operator.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "operator.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/operator/templates/deployment.yaml b/charts/operator/templates/deployment.yaml new file mode 100644 index 00000000..04a8b097 --- /dev/null +++ b/charts/operator/templates/deployment.yaml @@ -0,0 +1,45 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "operator.fullname" . }} + namespace: {{ include "operator.namespace" . }} + labels: + {{- include "operator.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "operator.selectorLabels" . | nindent 6 }} + strategy: + type: Recreate + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "operator.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + automountServiceAccountToken: true + serviceAccountName: {{ include "operator.serviceAccountName" . }} + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- if gt (len .Values.customArgs) 0 }} + args: + {{- toYaml .Values.customArgs | nindent 12 }} + {{- end }} + env: + - name: "RUST_LOG" + value: "INFO" + {{- if .Values.extraEnv }} + {{- toYaml .Values.extraEnv | nindent 12 }} + {{- end }} + resources: + {{- toYaml .Values.resources | nindent 12 }} diff --git a/charts/operator/templates/rbac-resources.yaml b/charts/operator/templates/rbac-resources.yaml new file mode 100644 index 00000000..49838d8b --- /dev/null +++ b/charts/operator/templates/rbac-resources.yaml @@ -0,0 +1,59 @@ +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: {{ template "operator.fullname" . }}-role +rules: +- apiGroups: + - "" + resources: + - events + verbs: + - "*" +- apiGroups: + - "" + resources: + - endpoints + - configmaps + - secrets + verbs: + - get + - list + - watch +- apiGroups: + - "" + resources: + - pods + - pods/status + - pods/finalizers + verbs: + - "*" +- apiGroups: + - "" + resources: + - services + - services/status + - services/finalizers + verbs: + - "*" +- apiGroups: + - "apibara.com" + resources: + - indexers + - indexers/status + - indexers/finalizers + verbs: + - "*" +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: {{ template "operator.fullname" . }}-rolebinding +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: {{ template "operator.fullname" . }}-role +subjects: +- kind: ServiceAccount + name: {{ template "operator.serviceAccountName" . }} + namespace: {{ template "operator.namespace" . }} diff --git a/charts/operator/templates/service-account.yaml b/charts/operator/templates/service-account.yaml new file mode 100644 index 00000000..85e2a843 --- /dev/null +++ b/charts/operator/templates/service-account.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "operator.serviceAccountName" . }} + namespace: {{ include "operator.namespace" . }} + labels: + {{- include "operator.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/operator/templates/tests/indexers.yaml b/charts/operator/templates/tests/indexers.yaml new file mode 100644 index 00000000..faf57920 --- /dev/null +++ b/charts/operator/templates/tests/indexers.yaml @@ -0,0 +1,32 @@ +{{- if .Values.test.enabled }} +--- +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "operator.fullname" . }}-test-api-key + namespace: {{ include "operator.namespace" . }} +stringData: + production: {{ .Values.test.apiKey }} +--- +apiVersion: apibara.com/v1alpha2 +kind: Indexer +metadata: + name: {{ include "operator.fullname" . }}-test-indexer + namespace: {{ include "operator.namespace" . }} +spec: + source: + gitHub: + repo: dna + owner: apibara + revision: main + subpath: examples/console + sink: + script: starknet_to_console.js + type: console + env: + - name: AUTH_TOKEN + valueFrom: + secretKeyRef: + name: {{ include "operator.fullname" . }}-test-api-key + key: production +{{- end }} diff --git a/charts/operator/values.yaml b/charts/operator/values.yaml new file mode 100644 index 00000000..e6f0991a --- /dev/null +++ b/charts/operator/values.yaml @@ -0,0 +1,50 @@ +image: + repository: quay.io/apibara/operator + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +# namespace: apibara-system + +replicaCount: 1 + +# Custom args for the operator, e.g. `["--namespace", "my-namespace"]` +customArgs: + - start + +# Additional environment variables to set +extraEnv: [] + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "apibara-operator-manager" + +podAnnotations: {} + +resources: + {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +# Values used for testing +test: + enabled: false + # DNA auth token + apiKey: "" diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md index 5c34edd6..1e8ad4a5 100644 --- a/cli/CHANGELOG.md +++ b/cli/CHANGELOG.md @@ -6,6 +6,16 @@ The format is based on [Common Changelog](https://common-changelog.org/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.5.0] - 2024-05-23 + +_Improve `apibara test` command when working with floating point numbers._ + +### Added + +- Add a `testOptions` section to `apibara test` snapshots. +- Add the `testOptions.floatingPointDecimals` option to control up to how many + decimal places to compare floating point numbers in snapshots. + ## [0.4.2] - 2024-01-19 _Allow network access._ diff --git a/cli/Cargo.toml b/cli/Cargo.toml index 4b872db7..4d015583 100644 --- a/cli/Cargo.toml +++ b/cli/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "apibara-cli" -version = "0.4.2" +version = "0.5.0" edition.workspace = true license.workspace = true @@ -36,3 +36,4 @@ similar-asserts = { version = "1.4.2", features = [ walkdir = "2.3.3" tracing.workspace = true tempfile.workspace = true +float-cmp = "0.9.0" diff --git a/cli/src/test/compare.rs b/cli/src/test/compare.rs new file mode 100644 index 00000000..9dffbcef --- /dev/null +++ b/cli/src/test/compare.rs @@ -0,0 +1,67 @@ +use float_cmp::approx_eq; +use serde_json::Value; + +use super::snapshot::TestOptions; + +const DEFAULT_FP_DECIMALS: i64 = 20; + +/// Compare two outputs, taking into account test options like floating point precision. +pub fn outputs_are_equal(expected: &Value, actual: &Value, options: &TestOptions) -> bool { + let visitor = EqualityVisitor::from_options(options); + visitor.eq(expected, actual) +} + +struct EqualityVisitor { + floating_point_decimals: Option, +} + +impl EqualityVisitor { + pub fn from_options(options: &TestOptions) -> Self { + Self { + floating_point_decimals: options.floating_point_decimals, + } + } + + pub fn eq(&self, expected: &Value, actual: &Value) -> bool { + match (expected, actual) { + (Value::Number(expected), Value::Number(actual)) => self.number_eq(expected, actual), + (Value::Array(expected), Value::Array(actual)) => self.array_eq(expected, actual), + (Value::Object(expected), Value::Object(actual)) => self.object_eq(expected, actual), + (expected, actual) => expected == actual, + } + } + + fn number_eq(&self, expected: &serde_json::Number, actual: &serde_json::Number) -> bool { + let decimals = self.floating_point_decimals.unwrap_or(DEFAULT_FP_DECIMALS); + + match (expected.as_f64(), actual.as_f64()) { + (Some(expected), Some(actual)) => { + let epsilon = 10.0_f64.powi(-decimals as i32); + approx_eq!(f64, expected, actual, epsilon = epsilon) + } + _ => expected == actual, + } + } + + fn array_eq(&self, expected: &[Value], actual: &[Value]) -> bool { + expected.len() == actual.len() + && expected + .iter() + .zip(actual.iter()) + .all(|(expected, actual)| self.eq(expected, actual)) + } + + fn object_eq( + &self, + expected: &serde_json::Map, + actual: &serde_json::Map, + ) -> bool { + expected.len() == actual.len() + && expected + .iter() + .all(|(key, expected)| match actual.get(key) { + Some(actual) => self.eq(expected, actual), + None => false, + }) + } +} diff --git a/cli/src/test/mod.rs b/cli/src/test/mod.rs index 451621d9..42c56967 100644 --- a/cli/src/test/mod.rs +++ b/cli/src/test/mod.rs @@ -7,6 +7,7 @@ use tracing::warn; use crate::error::CliError; +mod compare; mod error; mod run; mod snapshot; diff --git a/cli/src/test/run.rs b/cli/src/test/run.rs index 0890548a..f731b42c 100644 --- a/cli/src/test/run.rs +++ b/cli/src/test/run.rs @@ -7,8 +7,7 @@ use tracing::warn; use walkdir::{DirEntry, WalkDir}; use apibara_sink_common::{ - load_script, NetworkFilterOptions, OptionsFromScript, ScriptOptions, - StreamConfigurationOptions, StreamOptions, + load_script, OptionsFromScript, ScriptOptions, StreamConfigurationOptions, StreamOptions, }; use colored::*; use error_stack::{Result, ResultExt}; @@ -19,6 +18,8 @@ use crate::error::CliError; use crate::test::error::get_assertion_error; use crate::test::snapshot::{Snapshot, SnapshotGenerator}; +use super::compare::outputs_are_equal; + const DEFAULT_NUM_BATCHES: usize = 1; fn to_relative_path(path: &Path) -> &Path { @@ -106,13 +107,9 @@ async fn run_test( .await .change_context(CliError)? .stream_configuration - .as_starknet() - .ok_or(CliError) - .attach_printable("Cannot convert StreamConfigurationOptions using as_starknet")? .filter; - let NetworkFilterOptions::Starknet(snapshot_filter) = - &snapshot.stream_configuration_options.filter; + let snapshot_filter = &snapshot.stream_configuration_options.filter; if snapshot_filter != filter { let left = format!("{:#?}", SimilarAssertsDebug(&snapshot_filter)); @@ -130,6 +127,7 @@ async fn run_test( let mut expected_outputs = vec![]; let mut found_outputs = vec![]; + let mut has_error = false; for message in snapshot.stream { let input = message["input"] .as_array() @@ -144,11 +142,15 @@ async fn run_test( .change_context(CliError) .attach_printable("failed to transform data")?; - expected_outputs.push(expected_output.clone()); - found_outputs.push(found_output.clone()); + if !outputs_are_equal(&expected_output, &found_output, &snapshot.test_options) { + has_error = true; + } + + expected_outputs.push(expected_output); + found_outputs.push(found_output); } - if expected_outputs != found_outputs { + if has_error { let message = get_assertion_error(&expected_outputs, &found_outputs); Ok(TestResult::Failed { message }) } else { diff --git a/cli/src/test/snapshot.rs b/cli/src/test/snapshot.rs index 7a627ffa..ed7cae5a 100644 --- a/cli/src/test/snapshot.rs +++ b/cli/src/test/snapshot.rs @@ -13,14 +13,23 @@ use tracing::debug; use crate::{error::CliError, test::SNAPSHOTS_DIR}; #[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] pub struct Snapshot { pub script_path: PathBuf, pub num_batches: usize, pub stream_options: StreamOptions, pub stream_configuration_options: StreamConfigurationOptions, + pub test_options: TestOptions, pub stream: Vec, } +#[derive(Serialize, Deserialize, Debug, Default)] +#[serde(rename_all = "camelCase")] +pub struct TestOptions { + #[serde(skip_serializing_if = "Option::is_none")] + pub floating_point_decimals: Option, +} + pub struct SnapshotGenerator { script_path: PathBuf, script: Script, @@ -167,6 +176,7 @@ impl SnapshotGenerator { num_batches: self.num_batches, stream_options, stream_configuration_options: self.stream_configuration_options, + test_options: TestOptions::default(), stream, }) } diff --git a/examples/common/ekubo.ts b/examples/common/ekubo.ts deleted file mode 100644 index 6c6458f9..00000000 --- a/examples/common/ekubo.ts +++ /dev/null @@ -1,54 +0,0 @@ -// Ekubo Position NFT -import type { Block, Filter } from "https://esm.sh/@apibara/indexer/starknet"; -import { hash, uint256 } from "https://esm.sh/starknet"; - -const contractAddress = - "0x07987d7865f098F348CaC18c853AE20eDdfe3ea1c029a49652e3ffd1b85F976E"; - -export const filter: Filter = { - header: { - weak: true, - }, - events: [ - { - fromAddress: contractAddress, - keys: [hash.getSelectorFromName("Transfer")], - }, - ], -}; - -// Iterate over all token transfers to pick the new NFT owner. -export function updateNftOwner({ header, events }: Block) { - const tokenIdCount = new Map(); - const tokenIdToOwner = new Map(); - - for (const { event } of events) { - const dest = event.data[1]; - const tokenId = uint256.uint256ToBN({ - low: event.data[2], - high: event.data[3], - }); - tokenIdToOwner.set(tokenId.toString(), dest); - tokenIdCount.set( - tokenId.toString(), - (tokenIdCount.get(tokenId.toString()) ?? 0) + 1, - ); - } - - return [...tokenIdToOwner.entries()].map(([tokenId, owner]) => ({ - entity: { - tokenId, - }, - update: { - "$set": { - tokenId, - owner, - updateAt: header?.timestamp, - updateAtBlock: header?.blockNumber, - }, - "$inc": { - transferCount: tokenIdCount.get(tokenId) ?? 0, - }, - }, - })); -} diff --git a/examples/common/jediswap.js b/examples/common/jediswap.js deleted file mode 100644 index b37034e9..00000000 --- a/examples/common/jediswap.js +++ /dev/null @@ -1,141 +0,0 @@ -import { hash } from "https://esm.run/starknet@5.14"; - -const PAIR_CREATED = selector("PairCreated"); -const UPGRADED = selector("Upgraded"); -const ADMIN_CHANGED = selector("AdminChanged"); -const BURN = selector("Burn"); -const MINT = selector("Mint"); -const SWAP = selector("Swap"); -const SYNC = selector("Sync"); -const APPROVAL = selector("Approval"); -const TRANSFER = selector("Transfer"); - -// Stream `PairCreated` events from JediSwap. -export const filter = { - header: { weak: true }, - events: [ - { - fromAddress: - "0x00dad44c139a476c7a17fc8141e6db680e9abc9f56fe249a105094c44382c2fd", - keys: [PAIR_CREATED], - includeReceipt: false, - }, - ], -}; - -// Export a `factory` function to enable factory mode. -// This function is called with data from the `filter` above -// and returns a filter that is used to stream child data. -// Filters from subsequent calls to `factory` are merged. -export function factory({ header, events }) { - // Create a filter with events for all pools created in this block. - const poolEvents = events.flatMap(({ event }) => { - const pairAddress = event.data[2]; - return [ - UPGRADED, - ADMIN_CHANGED, - BURN, - MINT, - SWAP, - SYNC, - APPROVAL, - TRANSFER, - ].map((eventKey) => ({ - fromAddress: pairAddress, - keys: [eventKey], - includeReceipt: false, - })); - }); - - // Insert data about the pools created in this block. - // Values returned in `data` are handled like values returned from - // `transform`. - const pools = events.flatMap(({ event, transaction }) => { - const token0 = event.data[0]; - const token1 = event.data[1]; - const pairAddress = event.data[2]; - return { - type: "PairCreated", - createdAt: header.timestamp, - createdAtBlockNumber: +header.blockNumber, - createdAtTxHash: transaction.meta.hash, - pairId: pairAddress, - token0Id: token0, - token1Id: token1, - }; - }); - - return { - filter: { - header: { weak: true }, - events: poolEvents, - }, - data: pools, - }; -} - -// The transform function is invoked with data from the child filter -// created by the factory function above. -export function transform({ header, events }) { - return events.flatMap(({ event, transaction }) => { - const txMeta = { - pairId: event.fromAddress, - createdAt: header.timestamp, - createdAtBlockNumber: +header.blockNumber, - createdAtTxHash: transaction.meta.hash, - }; - - switch (event.keys[0]) { - case UPGRADED: - return { - type: "Upgraded", - ...txMeta, - }; - case ADMIN_CHANGED: - return { - type: "AdminChanged", - ...txMeta, - }; - case BURN: - return { - type: "Burn", - ...txMeta, - }; - case MINT: - return { - type: "Mint", - ...txMeta, - }; - case SWAP: - return { - type: "Swap", - ...txMeta, - }; - case SYNC: - return { - type: "Sync", - ...txMeta, - }; - case APPROVAL: - return { - type: "Approval", - ...txMeta, - }; - case TRANSFER: - return { - type: "Transfer", - ...txMeta, - }; - default: - console.log("UNKNOWN"); - return []; - } - }); -} - -// Pad selector to match DNA felt length. -function selector(name) { - const bn = BigInt(hash.getSelectorFromName(name)); - const padded = bn.toString(16).padStart(64, "0"); - return "0x" + padded; -} diff --git a/examples/common/starknet.js b/examples/common/starknet.js index bf2547ec..e3b8bdd5 100644 --- a/examples/common/starknet.js +++ b/examples/common/starknet.js @@ -22,9 +22,7 @@ export const filter = { { fromAddress: "0x049D36570D4e46f48e99674bd3fcc84644DdD6b96F7C741B1562B82f9e004dC7", - keys: [ - hash.getSelectorFromName("Transfer"), - ], + keys: [hash.getSelectorFromName("Transfer")], includeReceipt: false, }, ], diff --git a/examples/console/starknet_factory.js b/examples/console/starknet_factory.js deleted file mode 100644 index 1d619c1b..00000000 --- a/examples/console/starknet_factory.js +++ /dev/null @@ -1,15 +0,0 @@ -import { filter, transform } from "../common/jediswap.js"; - -export { factory } from "../common/jediswap.js"; - -export const config = { - // streamUrl: "https://mainnet.starknet.a5a.ch", - streamUrl: "http://localhost:7171", - startingBlock: 486_000, - network: "starknet", - filter, - sinkType: "console", - sinkOptions: {}, -}; - -export default transform; diff --git a/examples/console/starknet_to_console.js b/examples/console/starknet_to_console.js index 33e9a891..5969d3cd 100644 --- a/examples/console/starknet_to_console.js +++ b/examples/console/starknet_to_console.js @@ -2,13 +2,12 @@ import { decodeTransfersInBlock, filter } from "../common/starknet.js"; // Configure indexer for streaming Starknet Goerli data starting at the specified block. export const config = { - streamUrl: "https://goerli.starknet.a5a.ch", - startingBlock: 800_000, + streamUrl: "https://sepolia.starknet.a5a.ch", + startingBlock: 1_000, network: "starknet", filter, sinkType: "console", - sinkOptions: { - }, + sinkOptions: {}, }; // Transform each block using the function defined in starknet.js. diff --git a/examples/mongo/ekubo_to_mongo.ts b/examples/mongo/ekubo_to_mongo.ts deleted file mode 100644 index d02876f7..00000000 --- a/examples/mongo/ekubo_to_mongo.ts +++ /dev/null @@ -1,21 +0,0 @@ -// Before running this script, you must start a local MongoDB server. -// See README.md for instructions. -import { updateNftOwner, filter } from "../common/ekubo.ts"; - -// Configure indexer for streaming Starknet Goerli data starting at the specified block. -export const config = { - streamUrl: "https://goerli.starknet.a5a.ch", - startingBlock: 835_000, - network: "starknet", - filter, - sinkType: "mongo", - sinkOptions: { - database: "example", - collectionName: "owners", - entityMode: true, - }, -}; - -// Transform each block using the function defined in ekubo.ts. -export default updateNftOwner; - diff --git a/examples/mongo/starknet_factory.js b/examples/mongo/starknet_factory.js deleted file mode 100644 index b649bcfc..00000000 --- a/examples/mongo/starknet_factory.js +++ /dev/null @@ -1,39 +0,0 @@ -import { - filter, - transform as jediswapTransform, - factory as jediswapFactory, -} from "../common/jediswap.js"; - -export const config = { - // streamUrl: "https://mainnet.starknet.a5a.ch", - streamUrl: "http://localhost:7171", - startingBlock: 486_000, - network: "starknet", - filter, - sinkType: "mongo", - sinkOptions: { - database: "example", - collectionNames: ["pairs", "events"], - }, -}; - -export function factory({ header, events }) { - const { filter, data } = jediswapFactory({ header, events }); - - const dataWithCollection = data.map((data) => ({ - collection: "pairs", - data, - })); - - return { - filter, - data: dataWithCollection, - }; -} - -export default function transform({ header, events }) { - return jediswapTransform({ header, events }).map((data) => ({ - collection: "events", - data, - })); -} diff --git a/examples/parquet/starknet_factory.js b/examples/parquet/starknet_factory.js deleted file mode 100644 index 64018399..00000000 --- a/examples/parquet/starknet_factory.js +++ /dev/null @@ -1,54 +0,0 @@ -import { - filter, - transform as jediswapTransform, - factory as jediswapFactory, -} from "../common/jediswap.js"; - -export const config = { - streamUrl: "https://mainnet.starknet.a5a.ch", - startingBlock: 486_000, - network: "starknet", - filter, - sinkType: "parquet", - sinkOptions: { - // Files will have data for 100 blocks each. - // In reality, you want this number to be higher (like 1_000), - // but for the sake of this example, we keep it low to generate - // files quickly. - batchSize: 100, - // Create multiple datasets with one indexer. - datasets: [ - "PairCreated", - "Upgraded", - "AdminChanged", - "Burn", - "Mint", - "Swap", - "Sync", - "Approval", - "Transfer", - ], - }, -}; - -export function factory({ header, events }) { - const { filter, data } = jediswapFactory({ header, events }); - - const datasets = data.map((data) => ({ - dataset: "PairCreated", - data, - })); - - return { - filter, - data: datasets, - }; -} - -export default function transform({ header, events }) { - // Dataset names can be dynamic. - return jediswapTransform({ header, events }).map((data) => ({ - dataset: data.type, - data, - })); -} diff --git a/examples/parquet/starknet_to_parquet.js b/examples/parquet/starknet_to_parquet.js index 306e68c2..bba80413 100644 --- a/examples/parquet/starknet_to_parquet.js +++ b/examples/parquet/starknet_to_parquet.js @@ -1,10 +1,10 @@ // See README.md for instructions. import { decodeTransfersInBlock, filter } from "../common/starknet.js"; -// Configure indexer for streaming Starknet Goerli data starting at the specified block. +// Configure indexer for streaming Starknet Sepolia data starting at the specified block. export const config = { - streamUrl: "https://goerli.starknet.a5a.ch", - startingBlock: 800_000, + streamUrl: "https://sepolia.starknet.a5a.ch", + startingBlock: 1_000, network: "starknet", filter, sinkType: "parquet", diff --git a/examples/postgres/README.md b/examples/postgres/README.md index a2b0b893..fd3c2172 100644 --- a/examples/postgres/README.md +++ b/examples/postgres/README.md @@ -4,9 +4,9 @@ _Mirror onchain data to a PostgreSQL table._ **Use cases** -- Quickly develop a backend for your dapp by sending data to Supabase or Hasura. -- Build internal dashboards with Retool or Illa. -- Join offchain and onchain data. +- Quickly develop a backend for your dapp by sending data to Supabase or Hasura. +- Build internal dashboards with Retool or Illa. +- Join offchain and onchain data. ## Usage @@ -62,11 +62,11 @@ progress. ```graphql query TransferCount { - transfers_aggregate { - aggregate { - count + transfers_aggregate { + aggregate { + count + } } - } } ``` @@ -74,29 +74,3 @@ query TransferCount { Refer to the [Hasura documentation to improve query performance](https://hasura.io/docs/latest/queries/postgres/performance/). - -### Entity mode - -The `entity_mode.js` script shows how to use _entity mode_. -The script needs the following table. Notice that in this case the `_cursor` is -a range of blocks. - -```sql -create table if not exists vrf_requests( - request_id bigint, - status bigint, - created_at timestamp, - created_at_tx text, - updated_at timestamp, - updated_at_tx text, - _cursor int8range -); -``` - -To get the most recent state of an entity, you must add the `upper_inf(_cursor)` -condition to your query. - -```sql -select * from vrf_requests where upper_inf(_cursor) -``` - diff --git a/examples/postgres/entity_mode.js b/examples/postgres/entity_mode.js deleted file mode 100644 index f8d4a345..00000000 --- a/examples/postgres/entity_mode.js +++ /dev/null @@ -1,85 +0,0 @@ -/* PostgreSQL Entity mode example - * - * This example shows how to use entity mode. - * It listens for VRF requests and status changes from the Pragma's smart - * contract on testnet. - */ - -const fromAddress = - "0x693d551265f0be7ccb3c869c64b5920929caaf486497788d43cb37dd17d6be6"; - -// RandomnessRequest event selector -const requestSelector = - "0x00e3e1c077138abb6d570b1a7ba425f5479b12f50a78a72be680167d4cf79c48"; - -// RandomnessStatusChange event selector -const statusChangeSelector = - "0x015510b399942790499934b72bc68b883f0905dee5da5aa36e489c9ffb096b8c"; - -export const config = { - streamUrl: "https://goerli.starknet.a5a.ch", - startingBlock: 908_100, - network: "starknet", - batchSize: 1, - finality: "DATA_STATUS_ACCEPTED", - filter: { - header: { weak: true }, - events: [ - { - fromAddress, - keys: [requestSelector], - includeTransaction: true, - includeReceipt: false, - }, - { - fromAddress, - keys: [statusChangeSelector], - includeTransaction: true, - includeReceipt: false, - }, - ], - }, - sinkType: "postgres", - sinkOptions: { - tableName: "vrf_requests", - entityMode: true, - }, -}; - -export default function transform({ header, events }) { - const { timestamp } = header; - return events.flatMap(({ event, transaction }) => { - if (event.keys[0] == requestSelector) { - // Initialize request entity. - const requestId = BigInt(event.data[0]); - return { - insert: { - request_id: +requestId.toString(), - created_at: timestamp, - created_at_tx: transaction.meta.hash, - updated_at: timestamp, - updated_at_tx: transaction.meta.hash, - status: 0, - }, - }; - } else if (event.keys[0] == statusChangeSelector) { - // Update request entity. - const requestId = BigInt(event.data[1]); - const status = BigInt(event.data[2]); - return { - entity: { - request_id: +requestId.toString(), - }, - update: { - status: +status.toString(), - updated_at: timestamp, - updated_at_tx: transaction.meta.hash, - }, - }; - } else { - // Do nothing. - return []; - } - }); -} - diff --git a/examples/postgres/starknet_to_postgres.js b/examples/postgres/starknet_to_postgres.js index d1fa95cd..8b1b91fe 100644 --- a/examples/postgres/starknet_to_postgres.js +++ b/examples/postgres/starknet_to_postgres.js @@ -2,10 +2,10 @@ // See README.md for instructions. import { decodeTransfersInBlock, filter } from "../common/starknet.js"; -// Configure indexer for streaming Starknet Goerli data starting at the specified block. +// Configure indexer for streaming Starknet Sepolia data starting at the specified block. export const config = { - streamUrl: "https://goerli.starknet.a5a.ch", - startingBlock: 800_000, + streamUrl: "https://sepolia.starknet.a5a.ch", + startingBlock: 1_000, network: "starknet", filter, sinkType: "postgres", diff --git a/examples/webhook/starknet_to_webhook.js b/examples/webhook/starknet_to_webhook.js index 5a4bd6a1..4e3cdbeb 100644 --- a/examples/webhook/starknet_to_webhook.js +++ b/examples/webhook/starknet_to_webhook.js @@ -1,9 +1,9 @@ import { decodeTransfersInBlock, filter } from "../common/starknet.js"; -// Configure indexer for streaming Starknet Goerli data starting at the specified block. +// Configure indexer for streaming Starknet Sepolia data starting at the specified block. export const config = { - streamUrl: "https://goerli.starknet.a5a.ch", - startingBlock: 800_000, + streamUrl: "https://sepolia.starknet.a5a.ch", + startingBlock: 1_000, network: "starknet", filter, sinkType: "webhook", diff --git a/install/install.sh b/install/install.sh index 0f00f05a..43cd03e7 100644 --- a/install/install.sh +++ b/install/install.sh @@ -21,7 +21,7 @@ main() { local _release_tag _release_tag=$( - curl -s "https://api.github.com/repos/${APIBARA_REPO}/releases" \ + curl -s "https://api.github.com/repos/${APIBARA_REPO}/releases?per_page=100" \ | jq -r '.[] | select((.prerelease==false) and (.tag_name | startswith("cli"))) | .tag_name' \ | head -n 1 ) diff --git a/nix/crates.nix b/nix/crates.nix index 4bf41654..0b59551d 100644 --- a/nix/crates.nix +++ b/nix/crates.nix @@ -322,6 +322,10 @@ in inputsFrom = [ allCrates ]; + + buildInputs = buildArgs.buildInputs ++ [ + pkgs.kubernetes-helm + ]; }); # Integration tests require an internet connection, which is diff --git a/sinks/sink-common/src/configuration.rs b/sinks/sink-common/src/configuration.rs index 7519ddb3..ff8de8c7 100644 --- a/sinks/sink-common/src/configuration.rs +++ b/sinks/sink-common/src/configuration.rs @@ -160,7 +160,7 @@ pub struct StreamConfigurationOptions { pub starting_block: Option, } -#[derive(Debug, Serialize, Deserialize, Clone)] +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] #[serde(tag = "network", content = "filter", rename_all = "camelCase")] pub enum NetworkFilterOptions { Starknet(v1alpha2::Filter),