Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DO NOT MERGE] Documentation for data model instance destination type #51

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

[DO NOT MERGE] Documentation for data model instance destination type #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
547f220
Documentation for data model instance destination type
vvemel Mar 28, 2022
752bf43
Update README.md
vvemel Apr 4, 2022
9763707
Update transformation_oidc.yaml
vvemel Apr 4, 2022
4d43c85
Update githubaction.md
vvemel Apr 4, 2022
6f27cb1
Update documentation
vvemel Jun 17, 2022
b8d0525
Update documentation
vvemel Jun 17, 2022
1c0be2d
Update README.md
vvemel Oct 7, 2022
234dcd3
Update transformation_oidc.yaml
vvemel Oct 7, 2022
2fef74c
Update githubaction.md
vvemel Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,20 @@ Use the Transformations command-line interface (**Transformations CLI**) to mana

The **Transformations CLI** is based on Python and replaces the [Jetfire CLI](https://github.com/cognitedata/jetfire-cli).

### Transformation Deploy Manifest
Transformations, that the user wants to deploy, are represented as `yaml` manifest files. You can find example manifests: [Manifest with OIDC authentication](https://github.com/cognitedata/transformations-cli/blob/alpha-data-model-instances-manifest/docs/source/transformation_oidc.yaml) and [Manifest with API key Authentication](https://github.com/cognitedata/transformations-cli/blob/alpha-data-model-instances-manifest/docs/source/transformation_apikey.yaml)

#### Data Model Instances Destination Type in Manifest
To deploy transformations with destination type `data model instances`, please check the example manifests.

```yaml
destination:
type: data_model_instances
modelExternalId: some_flexible_data_model # The flexible data model definiton externalId
spaceExternalId: some_space # The flexible data model space externalId
instanceSpaceExternalId: some_space2 # The flexible data model instance space externalId
```

### GitHub Action

The **Transformations CLI** provides a GitHub Action to deploy transformations. You'll find the documentation [here](githubaction.md).
Expand Down
9 changes: 8 additions & 1 deletion docs/source/transformation_oidc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ name: "test-cli-transform-oidc"
# Required
# Valid values are: "assets", "timeseries", "asset_hierarchy", events", "datapoints",
# "string_datapoints", "sequences", "files", "labels", "relationships",
# "raw", "data_sets", "sequence_rows"
# "raw", "data_sets", "sequence_rows", "data_model_instances"
destination:
type: "assets"

Expand All @@ -23,6 +23,13 @@ destination:
# type: sequence_rows
# externalId: some_sequence

# When writing to data model instances, use the following syntax:
# destination:
# type: data_model_instances
# modelExternalId: some_flexible_model
# spaceExternalId: some_space
# instanceSpaceExternalId: some_space

# Optional, default: true
shared: true

Expand Down
9 changes: 8 additions & 1 deletion githubaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ name: "test-cli-transform-oidc"
# Required
# Valid values are: "assets", "timeseries", "asset_hierarchy", events", "datapoints",
# "string_datapoints", "sequences", "files", "labels", "relationships",
# "raw", "data_sets", "sequence_rows"
# "raw", "data_sets", "sequence_rows", "data_model_instances"
destination:
type: "assets"

Expand All @@ -45,6 +45,13 @@ destination:
# type: sequence_rows
# externalId: some_sequence

# When writing to data model instances, use the following syntax:
# destination:
# type: data_model_instances
# modelExternalId: some_flexible_model
# spaceExternalId: some_space
# instanceSpaceExternalId: some_space

# Optional, default: true
shared: true

Expand Down