-
Notifications
You must be signed in to change notification settings - Fork 148
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #493 from amazeeio/release/0.15
Release/0.15
- Loading branch information
Showing
62 changed files
with
1,573 additions
and
420 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Create a report to help us improve | ||
|
|
||
| --- | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
|
|
||
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| **Screenshots** | ||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,17 +35,106 @@ And press the Play button (or press CTRL+ENTER). If all went well, you should se | |
|
|
||
| In order for Lagoon to deploy a project there is an example graphql in `create-project.gql`, which will create three API Objects: | ||
|
|
||
| 1. `project` This is your git repository that should be deployed, it needs to contain a `.lagoon.yml` file so Lagoon knows what it should do. | ||
| 1. `customer` The customer of the project. Can be used for an actual customer (if you use Lagoon in a multi-customer setup), or just to group multiple projects together. `customer` will hold the SSH Private Key that Lagoon will use to clone the Git repository of the project (the private key needs to be in a single string, where new lines are replaced by `\n` - see an example in /local-dev/api-data/api-data.sql) | ||
| 2. `openshift` The OpenShift Cluster that Lagoon should use to deploy to. Yes Lagoon is not only capable to deploy into the OpenShift that it is running itself, but actually to any OpenShift anywhere in the world. We need to know the following infos for this to work: | ||
| 1. `name` - Unique identifier of the OpenShift | ||
| 2. `console_url` - URL of the OpenShift console (without any `/console` suffix) | ||
| 3. `token` - the token of the `lagoon` Service Account created in this OpenShift (this is the same token that we also used during installation of Lagoon) | ||
| 3. `customer` The customer of the project. Can be used for an actual customer (if you use Lagoon in a multi-customer setup), or just to group multiple projects together. `customer` will hold the SSH Private Key that Lagoon will use to clone the Git repository of the project (the private key needs to be in a single string, where new lines are replaced by `\n` - see an example in /local-dev/api-data/api-data.sql) | ||
| 3. `project` This is your git repository that should be deployed, it needs to contain a `.lagoon.yml` file so Lagoon knows what it should do. | ||
|
|
||
| Just fill all the `[fill me]` you can find in the examples below, copy it into the GraphiQL Client, press play and if everything went well, you should get a response which shows you the name of the customer & openshift object and the full project object that just has been created. | ||
|
|
||
| Congrats again 🎉! | ||
|
|
||
| #### Give Access to the Project | ||
|
|
||
| In Lagoon the individual developers are authenticating themselves via their SSH Keys. Via their SSH Keys they have access to multiple things: | ||
|
|
||
| 1. The Lagoon API itself, where they can only see and edit projects they actually have access too | ||
| 2. Remote Shell Access to containers that are running in projects they have access too | ||
| 3. The Lagoon logging system, where a developer can find Request Logs, Container Logs, Lagoon Logs and many more. | ||
|
|
||
| First we need to add a new SSH Public key to the API: | ||
|
|
||
| ``` | ||
| mutation addSSHKey { | ||
| addSshKey(input:{name:"[name]", keyValue:"[keyValue]", keyType:SSH_RSA}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - `name` - Your identificator for this SSH Key, can by any string | ||
| - `keyValue` - The actual SSH Public Key Value (withouth the type on front and no name at the end, so just something like `AAAAB3NzaC1yc2EAAAADAQ...3QjzIOtdQERGZuMsi0p`) | ||
| - `keyType` - The type of the key, there are currently two types supported by Lagoon: `SSH_RSA` and `SSH_ED25519` | ||
|
|
||
| After we added the key we can give this key access to either a single project or a whole customer, while access to a whole customer means that this SSH key has automatically access to all projects that are assigned to this customer. | ||
|
|
||
| ``` | ||
| mutation addSshKeyToCustomer { | ||
| addSshKeyToCustomer(input:{customer:"[customer-name]", sshKey:"[sshKey-name]"}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ``` | ||
| mutation addSshKeyToProject { | ||
| addSshKeyToProject(input:{project:"[project-name]", sshKey:"[sshKey-name]"}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| That's it, now this SSH key can create Tokens via SSH, access containers and more. | ||
|
|
||
| Of corse it is possible to add an SSH Key to multiple customers and projects, whatever you need. | ||
|
|
||
| #### Add Notifications to the Project | ||
|
|
||
| If you like to know what exactly is going on during a deployment, we suggest to configure notifications for your project, they will provide: | ||
|
|
||
| - Push messages | ||
| - Build start information | ||
| - Build success or failure messages | ||
| - Many more | ||
|
|
||
| Like with the SSH Keys, we first add the Notification and then we connect the Notification to the Projects. As the Notifications can be quite different of their information they need, the notification types are built a bit more sofisticated and each Notification Type has it's own mutation: | ||
|
|
||
| ``` | ||
| mutation addNotificationSlack { | ||
| addNotificationSlack(input:{name:"[name]]", channel:"[channel]", webhook:"[webhook]"}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ``` | ||
| mutation addNotificationRocketChat { | ||
| addNotificationSlack(input:{name:"[name]]", channel:"[channel]", webhook:"[webhook]"}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - `name` - Is your own identificator for this Notification | ||
| - `channel` - Which channel should the message be sent to | ||
| - `webhook` - The URL of the webhook where messages should be sent, this is usally provided by the Chat System to you. | ||
|
|
||
| After we create that we can now connect this notification to our project: | ||
|
|
||
| ``` | ||
| mutation addNotificationToProject { | ||
| addNotificationToProject(input:{notificationType: SLACK, project:"[project-name]", notificationName:"[notification-name]"}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Now for every deployment you should see messages appear in your defined channel. | ||
|
|
||
| ## Example GraphQL queries | ||
|
|
||
| ### Add New OpenShift Target | ||
|
|
@@ -60,6 +149,7 @@ The OpenShift Cluster that Lagoon should use to deploy to. Yes, Lagoon is not on | |
| mutation { | ||
| addOpenshift(input: {name: "my-openshift", console_url:"[fill me]", token: "[fill me]"}) { | ||
| name | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
@@ -72,6 +162,7 @@ The customer of the project. Can be used for an actual customer (if you use Lago | |
| mutation { | ||
| addCustomer(input: {name: "[fill me]", private_key: "[fill me]"}) { | ||
| name | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
@@ -82,13 +173,15 @@ This is your git repository that should be deployed, it needs to contain a `.lag | |
|
|
||
| ``` | ||
| mutation { | ||
| addProject(input:{name: "first-project", customer:"customer-name", openshift: "my-openshift", git_url: "[fill me]"}) { | ||
| addProject(input:{name: "first-project", customer:[customer-id], openshift:[openshift-id], git_url: "[fill me]"}) { | ||
| name | ||
| customer { | ||
| name | ||
| id | ||
| } | ||
| openshift { | ||
| name | ||
| id | ||
| } | ||
| git_url, | ||
| active_systems_deploy, | ||
|
|
@@ -101,14 +194,13 @@ mutation { | |
|
|
||
| ### List Projects and Customers | ||
|
|
||
| This is a good comand to see an overview of all Projects, OpenShifts and Customers that exist within our Lagoon. | ||
|
|
||
| ``` | ||
| query whatIsThereAlready{ | ||
| allProjects { | ||
| name | ||
| git_url | ||
| notifications { | ||
| ...slack | ||
| } | ||
| } | ||
| allOpenshifts { | ||
| name | ||
|
|
@@ -119,8 +211,89 @@ query whatIsThereAlready{ | |
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Single Project | ||
|
|
||
| If you want to get an in depth look into a single project, this querry has been proven quite good: | ||
|
|
||
| ``` | ||
| query singleProject { | ||
| projectByName(name: "[projectname]") { | ||
| id | ||
| branches | ||
| git_url | ||
| pullrequests | ||
| production_environment | ||
| notifications(type: SLACK) { | ||
| ... on NotificationSlack { | ||
| name | ||
| channel | ||
| webhook | ||
| id | ||
| } | ||
| } | ||
| environments { | ||
| name | ||
| deploy_type | ||
| environment_type | ||
| } | ||
| openshift { | ||
| id | ||
| } | ||
| customer { | ||
| id | ||
| name | ||
| sshKeys { | ||
| id | ||
| name | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Project by Git URL | ||
|
|
||
| Don't remember how a project was called, but now the Git URL? Search no longer, there is an GraphQL Query for that: | ||
|
|
||
| ``` | ||
| query projectByGitUrl{ | ||
| projectByGitUrl(gitUrl: "[email protected]:org/repo.git") { | ||
| name | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| ### Update Objects | ||
|
|
||
| The Lagoon GraphQL API cannot only display Objects and create Objects, it also has the capability to update exisitng Objects, all of this happens in full GraphQL best practices manner. | ||
|
|
||
| Update the branches to deploy within a project: | ||
| ``` | ||
| mutation editProjectBranches { | ||
| updateProject(input:{id:109, patch:{branches:"^(prod|stage|dev|update)$"}}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| fragment slack on NotificationSlack { | ||
| name | ||
| Update the production Environment within a project (Important: Needs a redeploy in order for all changes to be reflected in the containers): | ||
| ``` | ||
| mutation editProjectProductionEnvironment { | ||
| updateProject(input:{id:109, patch:{production_environment:"master"}}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You can also combine multiple changes at once: | ||
|
|
||
| ``` | ||
| mutation editProjectProductionEnvironmentAndBranches { | ||
| updateProject(input:{id:109, patch:{production_environment:"master", branches:"^(prod|stage|dev|update)$"}}) { | ||
| id | ||
| } | ||
| } | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.