Skip to content

Commit

Permalink
correct info about publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
rauerhans committed Oct 10, 2023
1 parent 77ad492 commit 5dabce1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
8 changes: 2 additions & 6 deletions pages/adding-new-application/application-artifact-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,6 @@ tags:
- tag: data-pipelines
```

private recipe
private repository
sharing a private app between different plural accounts

The metadata in this file informs the Plural API about the application this artifact envelopes.
It will store its name, category and description, where it can find the icon and docs to display in the marketplace,
the notes template to prompt after installation, as well as links to any upstream git repository or homepage if applicable.
Expand All @@ -210,8 +206,8 @@ the notes template to prompt after installation, as well as links to any upstrea
> Behind the scenes, every `plural bundle install` triggers the OIDC client creation when you answer with `yes` on the OIDC prompt.
This happens, because every Client needs to be created before a `plural build` which then inputs the client info into the helm chart.

The `private` flag controls whether the artifact's bundles are published publicly or privately. (#TODO what does this mean for the end user exactly, how does one get access to public repositories)
Once the artifact makes it into the `main` branch of the [Plural artifact repository](https://github.com/pluralsh/plural-artifacts) on a successful PR the Github Actions workflow will publish it and its components.
The `private` flag controls whether the artifact's bundles are published publicly or privately on a `plural push`.
It should be set to the same value as the `private` flag in inside the `repository.yaml`.


`plural/receipes/dagster-aws.yaml`:
Expand Down
22 changes: 15 additions & 7 deletions pages/adding-new-application/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,30 @@ When you're done with implementing your artifact and you have created a publishe

1. Navigate to the directory of your artifact in your local copy of the [Plural artifacts git repository](https://github.com/pluralsh/plural-artifacts).
2. Locate the `Pluralfile`.
3. Enter the name of your publisher as the first argument in the `ATTRIBUTES` line. The arbument is case sensitive. E.g. if your publisher is called `Mypublisher`, it should look like this:
3. Enter the name of your publisher as the first argument in the `ATTRIBUTES` line. E.g. if your publisher is called `mypublisher`, it should look like this:

```
REPO dagster
ATTRIBUTES Mypublisher repository.yaml
ATTRIBUTES mypublisher repository.yaml
TF terraform/*
HELM helm/*
RECIPE plural/recipes/*
```

4. Finally, publish your artifact with the command `plural apply -f Pluralfile`.
4. Finally, publish your artifact with the command `plural apply -f Pluralfile`. E.g. for our dagster example
```console
$ plural apply -f Pluralfile
Setting attributes for dagster
upload progress 100% |███████████████████████████████████████████████████████████████| ( 0B/4.8 kB, )
pushing terraform terraform/aws
upload progress 100% |███████████████████████████████████████████████████████████████| ( 0B/1.7 kB, )
pushing helm helm/dagster...✓
pushing recipe plural/recipes/dagster-aws.yaml✓
```

## Public vs Private Artifacts
Artifacts can be published with a `private: true` or `private: false` setting in the `repository.yaml` (the `private` flag inside each recipe YAML needs to match the `private` flag in the `repository.yaml`).
Bundles from private artifacts can only be downloaded and installed by users from the same account the publisher was created in.
Artifacts created, and published privately by you, are not visible in the public marketplace.
By default only Plural developers can publish artifacts publicly.
Artifacts can be published with a `private: true` or `private: false` setting in the `repository.yaml`.
Bundles from private artifacts are only visible for, and can only be downloaded and installed by, users from the same account the publisher was created in.
If you want to publish your artifact publicly, too, you need to open a PR in the [Plural artifacts git repository](https://github.com/pluralsh/plural-artifacts), so the Plural team can review your code.
Artifacts published publicly by you are also visible in the public marketplace.

0 comments on commit 5dabce1

Please sign in to comment.