FileWatch v1alpha1


import ""




FileWatchSpec defines the desired state of FileWatch

  • watchedPaths ([]string), required

    WatchedPaths are paths of directories or files to watch for changes to. It cannot be empty.

  • disableSource (DisableSource)

    Specifies how to disable this.

    Points at a thing that can control whether something is disabled

    • disableSource.configMap (ConfigMapDisableSource)

      This DisableSource is controlled by a ConfigMap

      Specifies a ConfigMap to control a DisableSource

    • disableSource.configMap.key (string), required

      The key where the enable/disable state is stored.

    • (string), required

      The name of the ConfigMap

  • ignores ([]IgnoreDef)

    Ignores are optional rules to filter out a subset of changes matched by WatchedPaths.

    Describes sets of file paths that the FileWatch should ignore.

    • ignores.basePath (string), required

      BasePath is the base path for the patterns. It cannot be empty.

      If no patterns are specified, everything under it will be recursively ignored.

    • ignores.patterns ([]string)

      Patterns are dockerignore style rules. Absolute-style patterns will be rooted to the BasePath.



FileWatchStatus defines the observed state of FileWatch

  • disableStatus (DisableStatus)

    Details about whether/why this is disabled.


    • disableStatus.disabled (boolean), required

      Whether this is currently disabled.

    • disableStatus.lastUpdateTime (Time), required

      The last time this status was updated.

      Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    • disableStatus.reason (string), required

      The reason this status was updated.

  • error (string)

    Error is set if there is a problem with the filesystem watch. If non-empty, consumers should assume that no filesystem events will be seen and that the file watcher is in a failed state.

  • fileEvents ([]FileEvent)

    FileEvents summarizes batches of file changes (create, modify, or delete) that have been seen in ascending chronological order. Only the most recent 20 events are included.


    • fileEvents.seenFiles ([]string), required

      SeenFiles is a list of paths which changed (create, modify, or delete).

    • fileEvents.time (MicroTime), required

      Time is an approximate timestamp for a batch of file changes.

      This will NOT exactly match any inode attributes (e.g. ctime, mtime) at the filesystem level and is purely informational or for use as an opaque watermark.

      MicroTime is version of Time with microsecond level precision.

  • lastEventTime (MicroTime)

    LastEventTime is the timestamp of the most recent file event. It is zero if no events have been seen yet.

    If the specifics of which files changed are not important, this field can be used as a watermark without needing to inspect FileEvents.

    MicroTime is version of Time with microsecond level precision.

  • monitorStartTime (MicroTime)

    MonitorStartTime is the timestamp of when filesystem monitor was started. It is zero if the monitor has not been started yet.

    MicroTime is version of Time with microsecond level precision.



  • apiVersion:

  • kind: FileWatchList

  • metadata (ListMeta)

  • items ([]FileWatch), required