You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Otomi turns any Kubernetes cluster into an Application Platform to provide paved roads from code to production
@@ -42,7 +42,7 @@ To install Otomi, make sure to have a K8s cluster running with at least:
42
42
Add the Helm repository:
43
43
44
44
```bash
45
-
helm repo add otomi https://otomi.io/otomi-core
45
+
helm repo add otomi https://otomi.io/apl-core
46
46
helm repo update
47
47
```
48
48
@@ -147,15 +147,15 @@ If you wish to contribute please read our [Contributor Code of Conduct](https://
147
147
148
148
If you want to say **thank you** or/and support the active development of Otomi:
149
149
150
-
-[Star](https://github.com/redkubes/otomi-core) the Otomi project on Github
150
+
-[Star](https://github.com/linode/apl-core) the Otomi project on Github
151
151
- Feel free to write articles about the project on [dev.to](https://dev.to/), [medium](https://medium.com/) or on your personal blog and share your experiences
152
152
153
153
This project exists thanks to all the people who have contributed
@@ -141,7 +141,7 @@ In the [Code structure](#Code-structure) chapter, you have learned about reusabl
141
141
142
142
> We present `myapp` integration. The `myapp` is an arbitrary name and can be anything else.
143
143
144
-
> A core apps are those defined in otomi-core. Do not confuse them with team services, which are defined in the values repo.
144
+
> A core apps are those defined in apl-core. Do not confuse them with team services, which are defined in the values repo.
145
145
146
146
## Using the default code snippet
147
147
@@ -316,11 +316,11 @@ TBD
316
316
317
317
## Using CLI while developing templates
318
318
319
-
Using Otomi CLI can be very helpful while integrating apps or developing new features that involve the execution of Helmfile because it allows you to render and validate manifests. It is possible to use Otomi CLI in development mode, so the Otomi CLI reflects changes made in your local `otomi-core` directory.
319
+
Using Otomi CLI can be very helpful while integrating apps or developing new features that involve the execution of Helmfile because it allows you to render and validate manifests. It is possible to use Otomi CLI in development mode, so the Otomi CLI reflects changes made in your local `apl-core` directory.
320
320
321
321
To run Otomi CLI in the development mode, you must:
322
322
323
-
- execute Otomi CLI commands from a root directory of the `otomi-core` project
323
+
- execute Otomi CLI commands from a root directory of the `apl-core` project
324
324
- export `ENV_DIR`
325
325
326
326
First, run `npm install` to build all modules required for CLI.
Copy file name to clipboardExpand all lines: docs/migrating-values.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Assumptions/conventions used in this document:
4
4
5
-
-`otomi-values` is a git repo with values bootstrapped by a version of an `otomi-core` container.
5
+
-`otomi-values` is a git repo with values bootstrapped by a version of an `apl-core` container.
6
6
7
7
### The problem
8
8
@@ -13,11 +13,11 @@ We break the schema (`values-schema.yaml`) in our `otomi-values` when:
13
13
- We move props around
14
14
- We mutate a property's type and/or it's value shape
15
15
16
-
In order to move to another version of `otomi-core` (which might contain some of these changes), we needed a mechanism that migrates the old `otomi-values` to conform to the new schema. So we came up with a simple approach that serves our simple schema.
16
+
In order to move to another version of `apl-core` (which might contain some of these changes), we needed a mechanism that migrates the old `otomi-values` to conform to the new schema. So we came up with a simple approach that serves our simple schema.
17
17
18
18
### Solution
19
19
20
-
By comparing the diff between the old and the new schema a developer is able to create change records in `otomi-core` and store them in `values-changes.yaml`. Each record is given a successive number. If a user wants to upgrade the platform to a newer version of `otomi-core`, these change records will have to be applied to the values in successive order. When a dev runs `otomi commit` in an `otomi-values` repo, changes made to `otomi.version` will be detected, and the migration script will run in the newer container. The script only needs to compare the new `version` in `values-schema.yaml` with the `version` found in `otomi-values`.
20
+
By comparing the diff between the old and the new schema a developer is able to create change records in `apl-core` and store them in `values-changes.yaml`. Each record is given a successive number. If a user wants to upgrade the platform to a newer version of `apl-core`, these change records will have to be applied to the values in successive order. When a dev runs `otomi commit` in an `otomi-values` repo, changes made to `otomi.version` will be detected, and the migration script will run in the newer container. The script only needs to compare the new `version` in `values-schema.yaml` with the `version` found in `otomi-values`.
21
21
22
22
### Change records
23
23
@@ -72,7 +72,7 @@ changes:
72
72
73
73
### Workflow
74
74
75
-
Every time a developer changes the schema (`values-schema.yaml`) and adds change records, the `otomi migrate` command should be performed that will migrate the values to the new structure. For the following example workflow, we assume that the current (new) schema version of `otomi-core` is `4`, and the previous `otomi-values` version is at `3`.
75
+
Every time a developer changes the schema (`values-schema.yaml`) and adds change records, the `otomi migrate` command should be performed that will migrate the values to the new structure. For the following example workflow, we assume that the current (new) schema version of `apl-core` is `4`, and the previous `otomi-values` version is at `3`.
0 commit comments