Skip to main content

Product and example: who maintains what

An EasyFabric platform is built from two kinds of things. Some of it is the product: EasyFabric versions it, maintains it and tells you in advance when something goes away. The rest is a working example that becomes yours the moment you adopt it.

PartWhat it isWho maintains it
The easyfabric wheelProductEasyFabric
The GeneratorProductEasyFabric
The notebook templates and the Meta notebooksProductEasyFabric
The Yml folder: pipelines and deploymentThe process of "pushing a button" to make your configuration actual, working software in the cloud. scriptsWorking exampleYou, after adoption

The product​

The wheel, the Generator, and the notebook templates and Meta notebooks carry a version, and every release describes what changed. An option that is going away is first deprecated: it keeps working and reports a warning, and it is removed no earlier than two minor versions later. An option deprecated in 0.9 is removed in 1.1 at the earliest.

Which wheel your notebooks install is yours to choose with WheelPackageSpec in dp.<env>.yaml: follow the newest release, or pin one version.

The example: the Yml folder​

The Yml folder holds the Azure DevOps pipelines and the scripts they call. It ships in the platform zip of every release as a set that works together, and that is where our part ends. Once the folder is in your repository it is yours: you adapt it to your own agents, service connections and release process, and you keep it working.

EasyFabric does not replace or repair Yml files in your repository. A change you make there stays, and a newer release never overwrites it.

Adopting a newer version of the example​

You are not required to follow the example. When a newer release has a pipelineAn automated "conveyor belt" that moves data from one place to another or performs a task automatically. change you want, take it like this:

  1. Look up the release in https://core.easyfabric.net/api/platform/versions.json. The notes of a release have a section Yml example: files that change together, which lists the Yml files that changed as one set.
  2. Download the platform zip of that release, https://core.easyfabric.net/api/platform/easyfabric-platform-<version>.zip, and unpack it outside your repository.
  3. Copy the whole listed set from the zip's Yml folder into a branch. When you skipped releases, take the sets of the releases in between as well.
  4. Review the diff, re-apply your own adjustments, and merge it the way you merge any other change.

Take the set, not single files. A pipeline, the step template it calls and the script behind that template change together; one of them without the others gives a pipeline that fails halfway through a deployment.

Take it from a release, not from the main branch. A release is a state that was tested as a whole; main is work in progress.