diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..8899284610 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,114 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +hello@kestra.io. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..9cc12a8870 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,68 @@ +## Code of Conduct + +This project and everyone participating in it is governed by the +[Kestra Code of Conduct](https://github.com/kestra-io/kestrablob/master/CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report unacceptable behavior +to . + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + + +### Submit issues + +### Reporting bugs +Bug reports help us make Kestra better for everyone. We provide a preconfigured template for bugs to make it very clear what information we need. +Please search within our [already reported bugs](https://github.com/kestra-io/kestra/issues?q=is%3Aissue+is%3Aopen+label%3Abug) before raising a new one to make sure you're not raising a duplicate. + +### Reporting security issues +Please do not create a public GitHub issue. If you've found a security issue, please email us directly at hello@kestra.io instead of raising an issue. + + +### Requesting new features +To request new features, please create an issue on this project. +If you would like to suggest a new feature, we ask that you please use our issue template. It contains a few essential questions that help us understand the problem you are looking to solve and how you think your recommendation will address it. +To see what has already been proposed by the community, you can look [here](https://github.com/kestra-io/kestra/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement). +Watch out for duplicates! If you are creating a new issue, please check existing open, or recently closed. Having a single voted for issue is far easier for us to prioritize. + +### Your First Code Contribution + +#### Requirements +The following dependencies are required to build Kestra locally. +- Java 11+ +- Node 14+ +- Docker & Docker Compose +- an IDE (Intellij IDEA, Eclipse or VS Code) + +To start contributing: +- Start by [forking](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repository +- Clone the fork on your workstation: + +```shell +git clone git@github.com:{YOUR_USERNAME}/kestra.git +cd kestra +``` + +#### Develop backend +Open the cloned repository in your favorite IDE. In most of decent IDE, gradle build will be detected and all dependencies will be downloaded. + +- You may need to enable java annotation processors since we have using it a lot. +- The main class is `io.kestra.cli.App` +- pass as program arguments the server you want to develop, for example `server standalone` will the [standalone server](https://kestra.io/docs/administrator-guide/servers/#kestra-standalone-development-environment-servers) +- There is also a lot of unit test that will help you to validate your code (and you must provide unit test for any pull request). + +#### Develop frontend +The frontend is located on `/ui` folder. + +- `npm install` +- create a files `ui/.env.development.local` with content `VUE_APP_API_URL=http://localhost:8080` (or your actual server url) +- `npm run server` will start the development server with hot reload. + + +#### Develop plugins +A complete documentation for developing plugin can be found [here](https://kestra.io/docs/plugin-developer-guide/). + +### Improving The Documentation +The main documentation is located in a separate [repository](https://github.com/kestra-io/kestra.io). For task documentation, there are located directly on Java source using [swagger annotation](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations) (Example: [for Bash tasks](https://github.com/kestra-io/kestra/blob/develop/core/src/main/java/io/kestra/core/tasks/scripts/AbstractBash.java)) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..95c40e1ef1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ + + + + +close # diff --git a/README.md b/README.md index b00fb183a5..b6de531744 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,22 @@

- Kestra, Infinitely scalable open source orchestration & scheduling platform.
+ Infinitely scalable open source orchestration & scheduling platform.

- License + License Commits-per-month - Github star - Last Version + Github star + Last Version Docker pull Artifact Hub Kestra infinitely scalable orchestration and scheduling platform Discord - Github discussions + Github discussions Twitter Code Cov - Github Actions + Github Actions

@@ -38,6 +38,10 @@

modern data orchestration and scheduling platform

+## Demo + +Play with our [demo app](https://demo.kestra.io)! + ## What is Kestra ? Kestra is an infinitely scalable orchestration and scheduling platform, creating, running, scheduling, and monitoring millions of complex pipelines. @@ -57,16 +61,19 @@ namespace: my.company.teams inputs: - type: FILE name: uploaded + description: A Csv file to be uploaded through API or UI tasks: - - id: "archive" - type: "io.kestra.plugin.gcp.gcs.Upload" - description: "Archive the file on Google Cloud Storage bucket" + - id: archive + type: io.kestra.plugin.gcp.gcs.Upload + description: Archive the file on Google Cloud Storage bucket from: "{{ inputs.uploaded }}" to: "gs://my_bucket/archives/{{ execution.id }}.csv" - - id: "csvReader" - type: "io.kestra.plugin.serdes.csv.CsvReader" + + - id: csvReader + type: io.kestra.plugin.serdes.csv.CsvReader from: "{{ inputs.uploaded }}" + - id: fileTransform type: io.kestra.plugin.scripts.nashorn.FileTransform description: This task will anonymize the contactName with a custom nashorn script (javascript over jvm). This show that you able to handle custom transformation or remapping in the ETL way @@ -75,6 +82,7 @@ tasks: if (row['contactName']) { row['contactName'] = "*".repeat(row['contactName'].length); } + - id: avroWriter type: io.kestra.plugin.serdes.avro.AvroWriter description: This file will convert the file from Kestra internal storage to avro. Again, we handling ETL since the conversion is done by Kestra before loading the data in BigQuery. This allow you to have some control before loading and to reject wrong data as soon as possible. @@ -100,6 +108,7 @@ tasks: { "name": "city", "type": ["null", "string"] } ] } + - id: load type: io.kestra.plugin.gcp.bigquery.Load description: Simply load the generated from avro task to BigQuery @@ -108,7 +117,8 @@ tasks: destinationTable: kestra-prd.demo.customer_copy format: AVRO from: "{{outputs.avroWriter.uri }}" - writeDisposition: WRITE_TRUNCATE* + writeDisposition: WRITE_TRUNCATE + - id: aggregate type: io.kestra.plugin.gcp.bigquery.Query description: Aggregate some data from loaded files @@ -138,7 +148,8 @@ Make sure you have already installed: - [Docker Compose](https://docs.docker.com/compose/install/) ### Launch Kestra -- Download the compose file [here](https://github.com/kestra-io/kestra/blob/develop/docker-compose.yml) +- Download the compose file [here](https://github.com/kestra-io/kestra/blob/develop/docker-compose.yml) and save it with the name `docker-compose.yml`, for linux and macos, you can run `wget https://raw.githubusercontent.com/kestra-io/kestra/develop/docker-compose.yml` +- Run `docker-compose pull` - Run `docker-compose up -d` - Open `http://localhost:8080` on your browser - Follow [this tutorial](https://kestra.io/docs/getting-started/) to create your first flow. @@ -148,10 +159,6 @@ Make sure you have already installed: - Use our [terraform provider](https://kestra.io/docs/terraform/) - Develop your [own plugins](https://kestra.io/docs/plugin-developer-guide/) - - - - ## Plugins Kestra is built on [plugin systems](https://kestra.io/plugins/). You can find your plugin to interact with your provider; alternatively, you can follow [simple steps](https://kestra.io/docs/plugin-developer-guide/) to develop your own plugin. Here are the official plugins that are available: @@ -217,10 +224,25 @@ Kestra is built on [plugin systems](https://kestra.io/plugins/). You can find yo This list is growing quickly as we are actively building more plugins, and we welcome contributions! +## Community Support + +Join our community if you need help, want to chat or have any other questions for us: + +- [GitHub](https://github.com/kestra-io/kestra/discussions) - Discussion forums and updates from the Kestra team +- [Twitter](https://twitter.com/kestra_io) - For all the latest Kestra news +- [Discord](https://discord.gg/5RgZmkW) - Join the conversation! Get all the latest updates and chat to the devs + + ## Roadmap See the [open issues](https://github.com/kestra-io/kestra/issues) for a list of proposed features (and known issues) or look at the [project board](https://github.com/orgs/kestra-io/projects/2). +## Developing locally & Contributing + +We love contributions big or small, check out [our guide](https://github.com/kestra-io/kestra/blob/master/CONTRIBUTING.md) on how to get started. + +See our [Plugin Developer Guide](https://kestra.io/docs/plugin-developer-guide/) for developing Kestra plugins. + ## License Apache 2.0 © [Kestra Technologies](https://kestra.io) diff --git a/docker-compose.yml b/docker-compose.yml index 54fa0157bd..444ed0ed2b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -53,7 +53,10 @@ services: kestra: image: kestra/kestra:develop-full - entrypoint: /usr/bin/wait-for-it -t 60 kafka:9092 && /usr/bin/wait-for-it -t 60 elasticsearch:9200 && /app/kestra server standalone + entrypoint: /bin/bash + command: + - -c + - "/usr/bin/wait-for-it -t 60 kafka:9092 && /usr/bin/wait-for-it -t 60 elasticsearch:9200 && /app/kestra server standalone" volumes: - kestra-data:/app/storage - /var/run/docker.sock:/var/run/docker.sock