docs: Add External contributor flow docs (#631)

* Add External contributor flow docs will help us gate the publishing of non-plural developed apps in this repo. * Remove limit on dagster job run This was causing even trivial jobs to OOM and it will likely be replaced anyway by users, so bias to making sure it works for demos * set primary recipes throughout
pluralsh · Apr 8, 2023 · 381a891 · 381a891
1 parent 2173ec1
commit 381a891
Show file tree

Hide file tree

Showing 17 changed files with 40 additions and 16 deletions.
diff --git a/.github/workflows/matrix-vendor-and-publish.yml b/.github/workflows/matrix-vendor-and-publish.yml
@@ -236,7 +236,7 @@ jobs:
       uses: pluralsh/setup-plural@v0.1.5
       with: 
         config: ${{ secrets.PLURAL_CONF }}
-        vsn: 0.6.17
+        vsn: 0.6.18
     - run: plural apply -f ${{ matrix.pluralfile }}
     - name: 'Run Semantic Release'
       run: APP_NAME=${{ matrix.repository }} semantic-release

diff --git a/README.md b/README.md
@@ -48,6 +48,31 @@ plural deploy
 
 This deploys the app with the local link you established. The `--force` flag will prevent any deduping w/in the Plural CLI from triggering.
 
+
+### External Contributor Flow
+
+For adding a new application the flow should be as follow:
+
+* create an initial pr from the setup given by `plural create` above.  You'll want to make sure the `repository.yaml` file is marked `private: true` and add your plural email to the list of contributors, eg:
+
+```
+name: airbyte
+description: airbyte deployed on plural
+category: DATA
+release_status: ALPHA
+private: true # keeps the repo from being publicly available to users until its ready
+contributors:
+- my@plural.email
+...
+```
+
+You'll want to create a pr with that initial setup which will create the initial repository and mark yourself as a conributor.
+
+* deploy a gcp or aws cluster to properly build and test the application, which can be done with the upgrade steps above
+* publish a new pr with the final version, and if it's good to go, we can drop the privacy flag.
+* if we're confident its ready for general use, we can move the `release_status` to `GA` or `BETA` as appropriate.
+
+
 ### Helpful utilities
 
 If you're frequently updating Helm dependencies, it can be complicated to sync them locally. To make this easier, you can just run:

diff --git a/baserow/plural/recipes/baserow-aws.yaml b/baserow/plural/recipes/baserow-aws.yaml
@@ -1,12 +1,12 @@
 name: baserow-aws
 description: Installs baserow on an aws eks cluster
 provider: AWS
+primary: true
 dependencies:
 - repo: bootstrap
   name: aws-k8s
 - repo: ingress-nginx
   name: ingress-nginx-aws
-
 sections:
 - name: baserow
   configuration:

diff --git a/baserow/plural/recipes/baserow-azure.yaml b/baserow/plural/recipes/baserow-azure.yaml
@@ -1,12 +1,12 @@
 name: baserow-azure
 description: Installs baserow on an aws eks cluster
 provider: AZURE
+primary: true
 dependencies:
 - repo: bootstrap
   name: azure-k8s
 - repo: ingress-nginx
   name: ingress-nginx-azure
-
 sections:
 - name: baserow
   configuration:

diff --git a/baserow/plural/recipes/baserow-gcp.yaml b/baserow/plural/recipes/baserow-gcp.yaml
@@ -1,12 +1,12 @@
 name: baserow-gcp
 description: Installs baserow on an aws eks cluster
 provider: GCP
+primary: true
 dependencies:
 - repo: bootstrap
   name: gcp-k8s
 - repo: ingress-nginx
   name: ingress-nginx-gcp
-
 sections:
 - name: baserow
   configuration:

diff --git a/dagster-agent/repository.yaml b/dagster-agent/repository.yaml
@@ -3,6 +3,7 @@ description: dagster-agent deployed on plural
 category: DATA
 private: false
 icon: plural/icons/dagster-primary-mark.png
+darkIcon: plural/icons/dagster-primary-mark.png
 notes: plural/notes.tpl
 gitUrl: https://github.com/dagster-io/dagster
 tags:

diff --git a/dagster/helm/dagster/Chart.yaml b/dagster/helm/dagster/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: dagster
 description: A Helm chart for Kubernetes
 type: application
-version: 0.1.30
+version: 0.1.31
 appVersion: 1.2.6
 dependencies:
 - name: postgres

diff --git a/dagster/helm/dagster/values.yaml b/dagster/helm/dagster/values.yaml
@@ -90,8 +90,6 @@ dagster:
           requests:
             cpu: 20m
             memory: 100Mi
-          limits:
-            memory: 160Mi
         dagsterApiGrpcArgs:
           - "--python-file"
           - "/example_project/example_repo/repo.py"

diff --git a/jenkins/plural/recipes/jenkins-aws.yaml b/jenkins/plural/recipes/jenkins-aws.yaml
@@ -1,12 +1,12 @@
 name: jenkins-aws
 description: Installs jenkins on an aws eks cluster
 provider: AWS
+primary: true
 dependencies:
 - repo: bootstrap
   name: aws-k8s
 - repo: ingress-nginx
   name: ingress-nginx-aws
-
 sections:
 - name: jenkins
   configuration:

diff --git a/jenkins/plural/recipes/jenkins-azure.yaml b/jenkins/plural/recipes/jenkins-azure.yaml
@@ -1,12 +1,12 @@
 name: jenkins-azure
 description: Installs jenkins on an aws eks cluster
 provider: AZURE
+primary: true
 dependencies:
 - repo: bootstrap
   name: azure-k8s
 - repo: ingress-nginx
   name: ingress-nginx-azure
-
 sections:
 - name: jenkins
   configuration:

diff --git a/jenkins/plural/recipes/jenkins-gcp.yaml b/jenkins/plural/recipes/jenkins-gcp.yaml
@@ -1,12 +1,12 @@
 name: jenkins-gcp
 description: Installs jenkins on an aws eks cluster
 provider: GCP
+primary: true
 dependencies:
 - repo: bootstrap
   name: gcp-k8s
 - repo: ingress-nginx
   name: ingress-nginx-gcp
-
 sections:
 - name: jenkins
   configuration:

diff --git a/jupyterhub/plural/recipes/jupyterhub-aws.yaml b/jupyterhub/plural/recipes/jupyterhub-aws.yaml
@@ -1,12 +1,12 @@
 name: jupyterhub-aws
 description: Installs jupyterhub on an aws eks cluster
 provider: AWS
+primary: true
 dependencies:
   - repo: bootstrap
     name: aws-k8s
   - repo: ingress-nginx
     name: ingress-nginx-aws
-
 sections:
   - name: jupyterhub
     configuration:

diff --git a/jupyterhub/plural/recipes/jupyterhub-azure.yaml b/jupyterhub/plural/recipes/jupyterhub-azure.yaml
@@ -1,12 +1,12 @@
 name: jupyterhub-azure
 description: Installs jupyterhub on an azure aks cluster
 provider: AZURE
+primary: true
 dependencies:
   - repo: bootstrap
     name: azure-k8s
   - repo: ingress-nginx
     name: ingress-nginx-azure
-
 sections:
   - name: jupyterhub
     configuration:

diff --git a/jupyterhub/plural/recipes/jupyterhub-gcp.yaml b/jupyterhub/plural/recipes/jupyterhub-gcp.yaml
@@ -1,12 +1,12 @@
 name: jupyterhub-gcp
 description: Installs jupyterhub on an gcp gke cluster
 provider: GCP
+primary: true
 dependencies:
   - repo: bootstrap
     name: gcp-k8s
   - repo: ingress-nginx
     name: ingress-nginx-gcp
-
 sections:
   - name: jupyterhub
     configuration:

diff --git a/tier/plural/recipes/tier-aws.yaml b/tier/plural/recipes/tier-aws.yaml
@@ -1,12 +1,12 @@
 name: tier-aws
 description: Installs tier on an aws eks cluster
 provider: AWS
+primary: true
 dependencies:
   - repo: bootstrap
     name: aws-k8s
   - repo: ingress-nginx
     name: ingress-nginx-aws
-
 sections:
   - name: tier
     configuration:

diff --git a/tier/plural/recipes/tier-azure.yaml b/tier/plural/recipes/tier-azure.yaml
@@ -1,12 +1,12 @@
 name: tier-azure
 description: Installs tier on an azure aks cluster
 provider: AZURE
+primary: true
 dependencies:
   - repo: bootstrap
     name: azure-k8s
   - repo: ingress-nginx
     name: ingress-nginx-azure
-
 sections:
   - name: tier
     configuration:

diff --git a/tier/plural/recipes/tier-gcp.yaml b/tier/plural/recipes/tier-gcp.yaml
@@ -1,12 +1,12 @@
 name: tier-gcp
 description: Installs tier on an gcp gke cluster
 provider: GCP
+primary: true
 dependencies:
   - repo: bootstrap
     name: gcp-k8s
   - repo: ingress-nginx
     name: ingress-nginx-gcp
-
 sections:
   - name: tier
     configuration: