@@ -36,32 +36,25 @@ are available for download on the [Releases](https://github.com/astronomer/orbit
36
36
Utilize the [ ` orbiter ` CLI] ( ./cli.md ) with existing translations to convert workflows
37
37
from other systems to an Airflow project.
38
38
39
- 1 . Set up a new folder, and create a ` workflow/ ` folder. Add your workflows files to it
39
+ 1 . ** Set up a new ` workflow/ ` folder. Add your workflows files to it**
40
40
``` shell
41
41
.
42
42
└── workflow/
43
43
├── workflow_a.json
44
44
├── workflow_b.json
45
45
└── ...
46
46
```
47
- 2. Determine the specific translation ruleset via:
47
+ 2. Determine the specific translation ruleset and repository via:
48
48
1. the [Origins](./origins.md) documentation
49
49
2. the [` orbiter list-rulesets` ](./cli.md#list-rulesets) command
50
50
3. or [by creating a translation ruleset](# authoring-rulesets-customization), if one does not exist
51
- 3. Install the translation ruleset via the [` orbiter install` ](./cli.md#install) command (substituting ` < REPOSITORY> ` with the value in the last step)
52
- ` ` ` shell
53
- orbiter install --repo=< REPOSITORY>
54
- ` ` `
55
- 4. Use the [` orbiter translate` ](./cli.md#translate) command with the ` < RULESET> ` determined in the last step
56
- This will produce output to an ` output/` folder:
57
- ` ` ` shell
58
- orbiter translate workflow/ --ruleset < RULESET> output/
59
- ` ` `
60
- 5. Review the contents of the ` output/` folder. If extensions or customizations are required, review
61
- [how to extend a translation ruleset](# extend-or-customize)
62
- 6. (optional) Utilize the [` astro` CLI](https://www.astronomer.io/docs/astro/cli/overview)
63
- to run Airflow instance with your migrated workloads
64
- 7. (optional) Deploy to [Astro](https://www.astronomer.io/try-astro/) to run your translated workflows in production! 🚀
51
+ 3. ** Install the translation ruleset** via the [` orbiter install` ](./cli.md#install) command
52
+ 4. ** Translate workloads** via the [` orbiter translate` ](./cli.md#translate) command
53
+ 5. ** Review** the contents of the output folder (default: ` output/` ).
54
+ If extensions or customizations are required, review [how to extend a translation ruleset](# extend-or-customize)
55
+ 6. (optional) ** Initialize** a full Airflow project
56
+ containing your migrated workloads with the [` astro` CLI](https://www.astronomer.io/docs/astro/cli/overview)
57
+ 7. (optional) ** Deploy** to [Astro](https://www.astronomer.io/try-astro/) to run your translated workflows in production! 🚀
65
58
66
59
# # Authoring Rulesets & Customization
67
60
Orbiter can be extended to fit specific needs, patterns, or to support additional origins.
@@ -95,9 +88,9 @@ To extend or customize an existing ruleset, you can easily modify it with simple
95
88
7. Append the new [Rule](./Rules_and_Rulesets/index.md)
96
89
to the [` translation_ruleset` ](./Rules_and_Rulesets/rulesets.md#orbiter.rules.rulesets.TranslationRuleset)
97
90
98
- 4. Invoke the ` orbiter` CLI , pointing it at your customized ruleset, and writing output to an ` output/ ` folder:
91
+ 4. Invoke the [ ` orbiter translate ` ](./cli.md#translate) command , pointing it at your customized ruleset
99
92
` ` ` shell
100
- orbiter translate workflow/ output/ --ruleset override.translation_ruleset
93
+ orbiter translate --ruleset override.translation_ruleset
101
94
` ` `
102
95
5. Follow the remaining steps of the [Translate](# translate) instructions
103
96
0 commit comments