diff --git a/docs/deploy-a-data-pipeline.md b/docs/deploy-a-data-pipeline.md new file mode 100644 index 0000000..6376ae1 --- /dev/null +++ b/docs/deploy-a-data-pipeline.md @@ -0,0 +1,74 @@ +# Deploying a pipeline + +Here you will find out: + +* Why we deploy pipelines +* How to deploy a pipeline with a step-by-step instruction + +## Why deploying a pipeline? + +You may need to make changes to your pipeline from time to time. If a developer is working on it, then it may interfere with the running pipeline. Pipelines are isolated. The changes may disrupt the running pipeline, hence the deployment mechanism comes in handy. Deployment means that we create a version of a pipeline that has a certain marking. It is customarily composed of three numbers separated by dots. This way, we can always be sure which version of the pipeline it is. + +## How to deploy a pipeline? + +You will have to follow these steps: + +1. Open your pipeline +2. Start deploying +3. Choose environment +4. Give your version a number +5. Deploy your pipeline + +### Open your pipeline + +First of all, you need a pipeline. If you haven't already created a pipeline, please create a new one. + +In the **Pipelines** view, open your pipeline: + +![Example pipeline view](/img/deployment/01.png) + +### Start deploying + +Click on the button with three dots and select **Deploy**: + +![Example pipeline view](/img/deployment/02.png) + +### Choose environment + +You will see the deployment view where you need to specify which environment you want to deploy to: + +![Example pipeline view](/img/deployment/03.png) + +You can choose either **Development** or **Production**: + +![Example pipeline view](/img/deployment/04.png) + +### Give your version a number + +Once you've chosen the environment, you will be prompted the version control: + +![Example pipeline view](/img/deployment/05.png) + +You need to determine the version number for your deployment along with: + +* default worker group +* worker group + +![Example pipeline view](/img/deployment/06.png) + +> Typically, there are 3 numbers: +> * major +> * minor +> * patch +> +> The first one indicates big changes. The second one informs about new features. The last one is used if some bugs have been fixed. + +### Deploy your pipeline + +When you're ready, you can click on the **Deploy** button. + +If the pipeline deployment has been successful, you will be transferred to the Deployments page where you can see the version of your deployment: + +![Example pipeline view](/img/deployment/07.png) + +Congratulations, you have successfully deployed a data pipeline on Dataplane! \ No newline at end of file diff --git a/docs/permissions.md b/docs/permissions.md new file mode 100644 index 0000000..cae3238 --- /dev/null +++ b/docs/permissions.md @@ -0,0 +1,150 @@ +# Permissions + +Often times, users of an application only have a certain set of functions that they can use. This set depends on the user's permissions. This means that one user can perform operations A, B, and C, while another user can only perform operation B, because they have no authority to perform operations A and C. + +In this part you will learn: + +* How to add users +* How to add access groups +* How to assign permissions +* What permissions there are and what they are for + +## How to add users + +First of all, before you learn how to assign permissions, you need to know how to add users. This instruction explains step-by-step how to add them to Dataplane. + +1. In order to add a new user, go to the **Team** page: + +![Permissions](/static/img/permissions/01.png) + +2. Click on the **Add** button. You will be prompted a side menu on the right side of your screen: + +![Permissions](/static/img/permissions/02.png) + +3. Fill in mandatory fields: + +* First name +* Last name +* Email +* Password + +If you wish, you can also specify: + +* Job title +* Timezone + +4. Having the fields filled in, click on the **Save** button: + +![Permissions](/static/img/permissions/03.png) + +A success message should be displayed unless the user has already existed in the system. If you have failed to add a user, please try to use a different email. + +5. User will appear on the list in the **Team** page: + +![Permissions](/static/img/permissions/04.png) + +Well done! You have sucessfully added a new user. + + +## How to add access groups + +Access groups are groups of users who share access permissions. Some users may have the same permissions, so to avoid assigning everyone their own permissions, we can create one access group, give it a set of permissions and connect a certain group of users to it. As a result, we don't need to assign permissions to a user - we can assign them to a specific access group that has all necessary permissions already set. + +The instruction below explains how to add access groups to Dataplane. + +1. Please go to the **Access Groups** page: + +![Permissions](/static/img/permissions/05.png) + +2. Click on the **Add** button. You will be prompted a side menu on the right side of your screen: + +![Permissions](/static/img/permissions/06.png) + +3. Give your access group a name (description is optional) and click on the **Save** button: + +![Permissions](/static/img/permissions/07.png) + +4. If nothing fails, you will receive information about success and your new access group will appear on the list: + +![Permissions](/static/img/permissions/08.png) + +Congratulations! You have sucessfully added a new access group. + + +## How to assign permissions + +As we have stated it before, we can assign permisions to: + +* A user +* Access groups + +Let's start with assigning permissions to a user. + +1. Go to the **Team** page and click on a user: + +![Permissions](/static/img/permissions/09.png) + +2. Here you will find all the details about the user and you can assign them permissions: + +![Permissions](/static/img/permissions/10.png) + +> In the **Belongs to environments** and **Belongs to access groups** sections you can specify which environments (e.g. Development, Production) and which access groups the user belongs to. + +3. In the **Permissions** section select from the dropdown list which permissions you would like to assign to the user: + +![Permissions](/static/img/permissions/11.png) + +Just select a permission and confirm by clicking on the **Add** button: + +![Permissions](/static/img/permissions/12.png) + +4. The permission will promptly appear below the dropdown, in its inherent section: + +![Permissions](/static/img/permissions/13.png) + +You can add multiple permissions. + +Now let's look at assigning permissions to access groups. + +5. Go to the **Access Groups** page and click on an access group: + +![Permissions](/static/img/permissions/14.png) + +6. Here you will find all the details about the access group: + +![Permissions](/static/img/permissions/15.png) + +> In the **Members** section you can add users that will belong to this access group. + +7. Like before, in the **Permissions** section you can select which permissions this access group will have: + +![Permissions](/static/img/permissions/16.png) + +Just select a permission and confirm by clicking on the **Add** button. The permission will promptly appear below the dropdown, in its inherent section: + +![Permissions](/static/img/permissions/17.png) + + +## What permissions there are and what they are for + +The table below shows what permissions are there exactly in Dataplane and what each of them means. + +| Permission Name | Description | +| ----------- | ----------- | +| Admin | It gives you system administrator rights for all environments | +| Manage environments | It allows you to make changes to environments | +| Environment admin | It gives you system administrator rights for a selected environment | +| Remove user from environment | It allows you to remove a user from a selected environment | +| Manage professions| It allows you to make changes to professions | +| View all pipelines | It allows you to see all pipelines of each user | +| Edit all pipelines | It allows you to make changes to all pipelines | +| Run all pipelines | It allows you to run all pipelines | +| Create pipelines | It allows you to create a pipeline | +| Manage pipeline permissions | It allows you to make changes to permissions of a pipeline | +| Manage secrets | It allows you to manage secrets | +| Manage workers | It allows you to manage workers | +| View workers | It allows you to view all workers | +| Deploy pipelines to this environment | It allows you to deploy pipelines only to a selected environment | +| Deploy pipelines from this environment | It allows you to deploy pipelines from a selected environment | +| View all deployments | It allows you view all deployments | +| Add user to environment | It allows you add a user only to a selected environment | diff --git a/static/img/deployment/01.png b/static/img/deployment/01.png new file mode 100644 index 0000000..f01ab57 Binary files /dev/null and b/static/img/deployment/01.png differ diff --git a/static/img/deployment/02.png b/static/img/deployment/02.png new file mode 100644 index 0000000..b1ff390 Binary files /dev/null and b/static/img/deployment/02.png differ diff --git a/static/img/deployment/03.png b/static/img/deployment/03.png new file mode 100644 index 0000000..ead8430 Binary files /dev/null and b/static/img/deployment/03.png differ diff --git a/static/img/deployment/04.png b/static/img/deployment/04.png new file mode 100644 index 0000000..d2e9522 Binary files /dev/null and b/static/img/deployment/04.png differ diff --git a/static/img/deployment/05.png b/static/img/deployment/05.png new file mode 100644 index 0000000..eb41cd1 Binary files /dev/null and b/static/img/deployment/05.png differ diff --git a/static/img/deployment/06.png b/static/img/deployment/06.png new file mode 100644 index 0000000..56e6a6d Binary files /dev/null and b/static/img/deployment/06.png differ diff --git a/static/img/deployment/07.png b/static/img/deployment/07.png new file mode 100644 index 0000000..7809b22 Binary files /dev/null and b/static/img/deployment/07.png differ diff --git a/static/img/deployment/08.png b/static/img/deployment/08.png new file mode 100644 index 0000000..80c58d8 Binary files /dev/null and b/static/img/deployment/08.png differ diff --git a/static/img/deployment/09.png b/static/img/deployment/09.png new file mode 100644 index 0000000..587ba35 Binary files /dev/null and b/static/img/deployment/09.png differ diff --git a/static/img/permissions/01.png b/static/img/permissions/01.png new file mode 100644 index 0000000..63268f6 Binary files /dev/null and b/static/img/permissions/01.png differ diff --git a/static/img/permissions/02.png b/static/img/permissions/02.png new file mode 100644 index 0000000..09f789a Binary files /dev/null and b/static/img/permissions/02.png differ diff --git a/static/img/permissions/03.png b/static/img/permissions/03.png new file mode 100644 index 0000000..f13b804 Binary files /dev/null and b/static/img/permissions/03.png differ diff --git a/static/img/permissions/04.png b/static/img/permissions/04.png new file mode 100644 index 0000000..0b7a0a3 Binary files /dev/null and b/static/img/permissions/04.png differ diff --git a/static/img/permissions/05.png b/static/img/permissions/05.png new file mode 100644 index 0000000..451f300 Binary files /dev/null and b/static/img/permissions/05.png differ diff --git a/static/img/permissions/06.png b/static/img/permissions/06.png new file mode 100644 index 0000000..dc83e37 Binary files /dev/null and b/static/img/permissions/06.png differ diff --git a/static/img/permissions/07.png b/static/img/permissions/07.png new file mode 100644 index 0000000..8142d35 Binary files /dev/null and b/static/img/permissions/07.png differ diff --git a/static/img/permissions/08.png b/static/img/permissions/08.png new file mode 100644 index 0000000..72784b7 Binary files /dev/null and b/static/img/permissions/08.png differ diff --git a/static/img/permissions/09.png b/static/img/permissions/09.png new file mode 100644 index 0000000..a21e8aa Binary files /dev/null and b/static/img/permissions/09.png differ diff --git a/static/img/permissions/10.png b/static/img/permissions/10.png new file mode 100644 index 0000000..70a3491 Binary files /dev/null and b/static/img/permissions/10.png differ diff --git a/static/img/permissions/11.png b/static/img/permissions/11.png new file mode 100644 index 0000000..78c358d Binary files /dev/null and b/static/img/permissions/11.png differ diff --git a/static/img/permissions/12.png b/static/img/permissions/12.png new file mode 100644 index 0000000..9c58aa7 Binary files /dev/null and b/static/img/permissions/12.png differ diff --git a/static/img/permissions/13.png b/static/img/permissions/13.png new file mode 100644 index 0000000..3332e10 Binary files /dev/null and b/static/img/permissions/13.png differ diff --git a/static/img/permissions/14.png b/static/img/permissions/14.png new file mode 100644 index 0000000..da0a205 Binary files /dev/null and b/static/img/permissions/14.png differ diff --git a/static/img/permissions/15.png b/static/img/permissions/15.png new file mode 100644 index 0000000..bd6899d Binary files /dev/null and b/static/img/permissions/15.png differ diff --git a/static/img/permissions/16.png b/static/img/permissions/16.png new file mode 100644 index 0000000..ad6e6f5 Binary files /dev/null and b/static/img/permissions/16.png differ diff --git a/static/img/permissions/17.png b/static/img/permissions/17.png new file mode 100644 index 0000000..84481e4 Binary files /dev/null and b/static/img/permissions/17.png differ