diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 275efb710..ed107525a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,37 +10,37 @@ jobs: build: runs-on: ubuntu-latest steps: - # See https://goreleaser.com/ci/actions/#fetch-depthness - - name: Checkout code - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - run: git fetch --force --tags - - name: Set up Go - uses: actions/setup-go@v3 - with: - go-version: '1.18' - cache: true - check-latest: true - - name: Get release tag - id: get_version - uses: battila7/get-version-action@v2 - - name: Run GoReleaser - uses: goreleaser/goreleaser-action@v2.6.1 - with: - distribution: goreleaser - version: latest - args: --snapshot --rm-dist - - name: Login to GitHub Packages Docker Registry - uses: docker/login-action@v1 - with: - registry: docker.pkg.github.com - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - name: Login to DockerHub - uses: docker/login-action@v1 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} - - name: Push Images - run: docker push docker.io/odpf/meteor:latest + # See https://goreleaser.com/ci/actions/#fetch-depthness + - name: Checkout code + uses: actions/checkout@v3 + with: + fetch-depth: 0 + - run: git fetch --force --tags + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: "1.18" + cache: true + check-latest: true + - name: Get release tag + id: get_version + uses: battila7/get-version-action@v2 + - name: Run GoReleaser + uses: goreleaser/goreleaser-action@v2.6.1 + with: + distribution: goreleaser + version: latest + args: --snapshot --rm-dist + - name: Login to GitHub Packages Docker Registry + uses: docker/login-action@v1 + with: + registry: docker.pkg.github.com + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Login to DockerHub + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + - name: Push Images + run: docker push docker.io/raystack/meteor:latest diff --git a/.github/workflows/build_dev.yml b/.github/workflows/build_dev.yml index 8e6069627..4a9ab3fdc 100644 --- a/.github/workflows/build_dev.yml +++ b/.github/workflows/build_dev.yml @@ -6,18 +6,18 @@ jobs: build: runs-on: ubuntu-latest steps: - - name: Checkout code - uses: actions/checkout@v3 - - name: Login to DockerHub - uses: docker/login-action@v1 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} - - name: Build and push - id: docker_build - uses: docker/build-push-action@v2 - with: - push: true - file: "./Dockerfile.dev" - tags: | - odpf/meteor:dev + - name: Checkout code + uses: actions/checkout@v3 + - name: Login to DockerHub + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + - name: Build and push + id: docker_build + uses: docker/build-push-action@v2 + with: + push: true + file: "./Dockerfile.dev" + tags: | + raystack/meteor:dev diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 19e168580..030ff109f 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -7,20 +7,19 @@ on: pull_request: jobs: - golangci: + lint: runs-on: ubuntu-latest steps: - - name: Checkout code + - name: Setup Go + uses: actions/setup-go@v4 + with: + go-version: "1.20" + - name: Checkout uses: actions/checkout@v3 with: fetch-depth: 0 - - name: Set up Go - uses: actions/setup-go@v3 - with: - go-version: '1.18' - # See https://github.com/golangci/golangci-lint-action#how-to-use - - name: golangci-lint + - name: Run linter uses: golangci/golangci-lint-action@v3 with: - version: v1.50 + version: v1.53 args: --timeout=5m diff --git a/.goreleaser.yml b/.goreleaser.yml index e29415e44..8151182a1 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,6 +1,6 @@ project_name: meteor -release: +release: prerelease: auto draft: true @@ -15,9 +15,9 @@ builds: binary: meteor flags: [-a] ldflags: - - -X github.com/odpf/meteor/cmd.Version={{.Tag}} - - -X github.com/odpf/meteor/cmd.BuildCommit={{.FullCommit}} - - -X github.com/odpf/meteor/cmd.BuildDate={{.Date}} + - -X github.com/raystack/meteor/cmd.Version={{.Tag}} + - -X github.com/raystack/meteor/cmd.BuildCommit={{.FullCommit}} + - -X github.com/raystack/meteor/cmd.BuildDate={{.Date}} goos: [linux] goarch: [amd64, arm64] # skip goarch 386 and arm due to conflicts with "github.com/blastrain/vitess-sqlparser" library env: @@ -27,9 +27,9 @@ builds: binary: meteor flags: [-a] ldflags: - - -X github.com/odpf/meteor/cmd.Version={{.Tag}} - - -X github.com/odpf/meteor/cmd.BuildCommit={{.FullCommit}} - - -X github.com/odpf/meteor/cmd.BuildDate={{.Date}} + - -X github.com/raystack/meteor/cmd.Version={{.Tag}} + - -X github.com/raystack/meteor/cmd.BuildCommit={{.FullCommit}} + - -X github.com/raystack/meteor/cmd.BuildDate={{.Date}} goos: [darwin] goarch: [amd64, 386, arm, arm64] env: @@ -39,9 +39,9 @@ builds: binary: meteor flags: [-a] ldflags: - - -X github.com/odpf/meteor/cmd.Version={{.Tag}} - - -X github.com/odpf/meteor/cmd.BuildCommit={{.FullCommit}} - - -X github.com/odpf/meteor/cmd.BuildDate={{.Date}} + - -X github.com/raystack/meteor/cmd.Version={{.Tag}} + - -X github.com/raystack/meteor/cmd.BuildCommit={{.FullCommit}} + - -X github.com/raystack/meteor/cmd.BuildDate={{.Date}} goos: [windows] goarch: [amd64, arm64] # skip goarch 386 and arm due to conflicts with "github.com/blastrain/vitess-sqlparser" library env: @@ -59,7 +59,7 @@ archives: format: zip checksum: - name_template: 'checksums.txt' + name_template: "checksums.txt" snapshot: name_template: "{{ .Tag }}-next" @@ -68,28 +68,27 @@ changelog: sort: asc filters: exclude: - - '^docs:' - - '^test:' - - '^build:' + - "^docs:" + - "^test:" + - "^build:" dockers: - - - goos: linux + - goos: linux goarch: amd64 ids: - linux dockerfile: Dockerfile image_templates: - - 'docker.io/odpf/{{.ProjectName}}:latest' - - 'docker.io/odpf/{{.ProjectName}}:{{ .Version }}' - - 'docker.io/odpf/{{.ProjectName}}:{{ .Version }}-amd64' + - "docker.io/raystack/{{.ProjectName}}:latest" + - "docker.io/raystack/{{.ProjectName}}:{{ .Version }}" + - "docker.io/raystack/{{.ProjectName}}:{{ .Version }}-amd64" brews: - name: meteor - homepage: "https://github.com/odpf/meteor" + homepage: "https://github.com/raystack/meteor" description: "Metadata collection tool." tap: - owner: odpf + owner: raystack name: homebrew-tap license: "Apache 2.0" folder: Formula @@ -101,4 +100,3 @@ brews: commit_author: name: Ravi Suhag email: suhag.ravi@gmail.com - diff --git a/Makefile b/Makefile index 2b0ad049b..a14779362 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ -NAME="github.com/odpf/meteor" +NAME="github.com/raystack/meteor" VERSION=$(shell git describe --always --tags 2>/dev/null) COVERFILE="/tmp/app.coverprofile" -PROTON_COMMIT := "8990712599f715240a3fbe9ce034a204b4a32245" +PROTON_COMMIT := "42b77358cbb68335607e99794f729e4a558974a5" .PHONY: all build clean test all: build @@ -34,9 +34,9 @@ test-coverage: # test test-plugins go tool cover -html=coverage-all.out generate-proto: ## regenerate protos - @echo " > cloning protobuf from odpf/proton" + @echo " > cloning protobuf from raystack/proton" @echo " > generating protobuf" - @buf generate --template buf.gen.yaml https://github.com/odpf/proton/archive/${PROTON_COMMIT}.zip#strip_components=1 --path odpf/assets/v1beta2 + @buf generate --template buf.gen.yaml https://github.com/raystack/proton/archive/${PROTON_COMMIT}.zip#strip_components=1 --path raystack/assets/v1beta2 @echo " > protobuf compilation finished" lint: ## Lint with golangci-lint diff --git a/README.md b/README.md index 7377888f6..f59e9ad7c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Meteor -![test workflow](https://github.com/odpf/meteor/actions/workflows/test.yml/badge.svg) -![build workflow](https://github.com/odpf/meteor/actions/workflows/build.yml/badge.svg) -[![Go Report Card](https://goreportcard.com/badge/github.com/odpf/meteor)](https://goreportcard.com/report/github.com/odpf/meteor) -[![Coverage Status](https://coveralls.io/repos/github/odpf/meteor/badge.svg?branch=main)](https://coveralls.io/github/odpf/meteor?branch=main) -[![Version](https://img.shields.io/github/v/release/odpf/meteor?logo=semantic-release)](Version) +![test workflow](https://github.com/raystack/meteor/actions/workflows/test.yml/badge.svg) +![build workflow](https://github.com/raystack/meteor/actions/workflows/build.yml/badge.svg) +[![Go Report Card](https://goreportcard.com/badge/github.com/raystack/meteor)](https://goreportcard.com/report/github.com/raystack/meteor) +[![Coverage Status](https://coveralls.io/repos/github/raystack/meteor/badge.svg?branch=main)](https://coveralls.io/github/raystack/meteor?branch=main) +[![Version](https://img.shields.io/github/v/release/raystack/meteor?logo=semantic-release)](Version) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache)](LICENSE) Meteor is a plugin driven agent for collecting metadata. Meteor has plugins to source metadata from a variety of data stores, services and message queues. @@ -24,9 +24,9 @@ It also has sink plugins to send metadata to variety of third party APIs and cat Explore the following resources to get started with Meteor: -- [Usage Guides](https://odpf.github.io/meteor/docs/guides/introduction) will help you get started on Meteor. -- [Concepts](https://odpf.github.io/meteor/docs/concepts/overview) describes all important Meteor concepts. -- [Contribute](https://odpf.github.io/meteor/docs/contribute/guide) contains resources for anyone who wants to contribute to Meteor. +- [Usage Guides](https://raystack.github.io/meteor/docs/guides/introduction) will help you get started on Meteor. +- [Concepts](https://raystack.github.io/meteor/docs/concepts/overview) describes all important Meteor concepts. +- [Contribute](https://raystack.github.io/meteor/docs/contribute/guide) contains resources for anyone who wants to contribute to Meteor. ## Installation @@ -34,7 +34,7 @@ Install Meteor on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. #### Binary (Cross-platform) -Download the appropriate version for your platform from [releases](https://github.com/odpf/meteor/releases) page. Once downloaded, the binary can be run from anywhere. +Download the appropriate version for your platform from [releases](https://github.com/raystack/meteor/releases) page. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account. Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location. @@ -42,7 +42,7 @@ Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/ ```sh # Install meteor (requires homebrew installed) -$ brew install odpf/tap/meteor +$ brew install raystack/tap/meteor # Upgrade meteor (requires homebrew installed) $ brew upgrade meteor @@ -67,7 +67,7 @@ $ meteor reference ```sh # Clone the repo -$ git clone https://github.com/odpf/meteor.git +$ git clone https://github.com/raystack/meteor.git # Install all the golang dependencies $ go mod tidy @@ -97,11 +97,11 @@ $ go test -tags=integration Development of Meteor happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Meteor. -Read our [contributing guide](https://odpf.github.io/meteor/docs/contribute/contributing) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Meteor. +Read our [contributing guide](https://raystack.github.io/meteor/docs/contribute/contributing) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Meteor. -To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/odpf/meteor/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started. +To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/raystack/meteor/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started. -This project exists thanks to all the [contributors](https://github.com/odpf/meteor/graphs/contributors). +This project exists thanks to all the [contributors](https://github.com/raystack/meteor/graphs/contributors). ## License diff --git a/agent/agent.go b/agent/agent.go index efcc0fe8c..9ab5f9e65 100644 --- a/agent/agent.go +++ b/agent/agent.go @@ -8,12 +8,12 @@ import ( "sync/atomic" "time" - "github.com/odpf/meteor/models" - "github.com/odpf/meteor/plugins" - "github.com/odpf/meteor/recipe" - "github.com/odpf/meteor/registry" - "github.com/odpf/salt/log" "github.com/pkg/errors" + "github.com/raystack/meteor/models" + "github.com/raystack/meteor/plugins" + "github.com/raystack/meteor/recipe" + "github.com/raystack/meteor/registry" + "github.com/raystack/salt/log" ) const defaultBatchSize = 1 diff --git a/agent/agent_test.go b/agent/agent_test.go index 4df7efd6d..469570bb8 100644 --- a/agent/agent_test.go +++ b/agent/agent_test.go @@ -7,22 +7,22 @@ import ( "time" "github.com/MakeNowJust/heredoc" - "github.com/odpf/meteor/agent" - "github.com/odpf/meteor/models" - "github.com/odpf/meteor/plugins" - "github.com/odpf/meteor/recipe" - "github.com/odpf/meteor/registry" - "github.com/odpf/meteor/test/mocks" - "github.com/odpf/meteor/test/utils" + "github.com/raystack/meteor/agent" + "github.com/raystack/meteor/models" + "github.com/raystack/meteor/plugins" + "github.com/raystack/meteor/recipe" + "github.com/raystack/meteor/registry" + "github.com/raystack/meteor/test/mocks" + "github.com/raystack/meteor/test/utils" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/mock" "github.com/stretchr/testify/require" "google.golang.org/protobuf/types/known/timestamppb" - v1beta2 "github.com/odpf/meteor/models/odpf/assets/v1beta2" - _ "github.com/odpf/meteor/plugins/extractors" // populate extractors registry - _ "github.com/odpf/meteor/plugins/processors" // populate processors registry - _ "github.com/odpf/meteor/plugins/sinks" // populate sinks registry + v1beta2 "github.com/raystack/meteor/models/raystack/assets/v1beta2" + _ "github.com/raystack/meteor/plugins/extractors" // populate extractors registry + _ "github.com/raystack/meteor/plugins/processors" // populate processors registry + _ "github.com/raystack/meteor/plugins/sinks" // populate sinks registry ) var ( diff --git a/agent/batch.go b/agent/batch.go index 2d87146cd..89f05cfec 100644 --- a/agent/batch.go +++ b/agent/batch.go @@ -3,7 +3,7 @@ package agent import ( "errors" - "github.com/odpf/meteor/models" + "github.com/raystack/meteor/models" ) // batch contains the configuration for a batch diff --git a/agent/config.go b/agent/config.go index d22fcc0fb..879b64e0e 100644 --- a/agent/config.go +++ b/agent/config.go @@ -3,8 +3,8 @@ package agent import ( "time" - "github.com/odpf/meteor/registry" - "github.com/odpf/salt/log" + "github.com/raystack/meteor/registry" + "github.com/raystack/salt/log" ) type Config struct { diff --git a/agent/retrier.go b/agent/retrier.go index 16c047e99..975601077 100644 --- a/agent/retrier.go +++ b/agent/retrier.go @@ -6,7 +6,7 @@ import ( "time" "github.com/cenkalti/backoff/v4" - "github.com/odpf/meteor/plugins" + "github.com/raystack/meteor/plugins" ) const ( diff --git a/agent/run.go b/agent/run.go index 83f91b796..72a6719e4 100644 --- a/agent/run.go +++ b/agent/run.go @@ -1,6 +1,6 @@ package agent -import "github.com/odpf/meteor/recipe" +import "github.com/raystack/meteor/recipe" // TaskType is the type of task type TaskType string diff --git a/agent/stream.go b/agent/stream.go index 07dd4b6df..b091bf13b 100644 --- a/agent/stream.go +++ b/agent/stream.go @@ -4,8 +4,8 @@ import ( "fmt" "sync" - "github.com/odpf/meteor/models" "github.com/pkg/errors" + "github.com/raystack/meteor/models" ) type streamMiddleware func(src models.Record) (dst models.Record, err error) diff --git a/agent/util.go b/agent/util.go index 481f9799f..7fe383807 100644 --- a/agent/util.go +++ b/agent/util.go @@ -1,8 +1,8 @@ package agent import ( - "github.com/odpf/meteor/plugins" - "github.com/odpf/meteor/recipe" + "github.com/raystack/meteor/plugins" + "github.com/raystack/meteor/recipe" ) func recipeToPluginConfig(pr recipe.PluginRecipe) plugins.Config { diff --git a/cmd/gen.go b/cmd/gen.go index 64870b4cf..1e1ebfaf8 100644 --- a/cmd/gen.go +++ b/cmd/gen.go @@ -5,7 +5,7 @@ import ( "os" "github.com/MakeNowJust/heredoc" - "github.com/odpf/meteor/recipe" + "github.com/raystack/meteor/recipe" "github.com/spf13/cobra" "gopkg.in/yaml.v3" ) @@ -19,7 +19,7 @@ func GenCmd() *cobra.Command { cmd := &cobra.Command{ Use: "gen", - Args: cobra.ExactValidArgs(1), + Args: cobra.MatchAll(cobra.ExactArgs(1)), Short: "Generate recipes", Long: heredoc.Doc(` Generate multiple recipes using a template and list of data. diff --git a/cmd/info.go b/cmd/info.go index 6d0045c13..0285071ea 100644 --- a/cmd/info.go +++ b/cmd/info.go @@ -5,9 +5,9 @@ import ( "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc" - "github.com/odpf/meteor/registry" - "github.com/odpf/salt/printer" - "github.com/odpf/salt/term" + "github.com/raystack/meteor/registry" + "github.com/raystack/salt/printer" + "github.com/raystack/salt/term" "github.com/spf13/cobra" ) diff --git a/cmd/lint.go b/cmd/lint.go index 447b860a9..bf5594415 100644 --- a/cmd/lint.go +++ b/cmd/lint.go @@ -6,14 +6,14 @@ import ( "os" "github.com/MakeNowJust/heredoc" - "github.com/odpf/meteor/agent" - "github.com/odpf/meteor/config" - "github.com/odpf/meteor/plugins" - "github.com/odpf/meteor/recipe" - "github.com/odpf/meteor/registry" - "github.com/odpf/salt/log" - "github.com/odpf/salt/printer" - "github.com/odpf/salt/term" + "github.com/raystack/meteor/agent" + "github.com/raystack/meteor/config" + "github.com/raystack/meteor/plugins" + "github.com/raystack/meteor/recipe" + "github.com/raystack/meteor/registry" + "github.com/raystack/salt/log" + "github.com/raystack/salt/printer" + "github.com/raystack/salt/term" "github.com/spf13/cobra" ) @@ -28,7 +28,7 @@ func LintCmd() *cobra.Command { return &cobra.Command{ Use: "lint [path]", Aliases: []string{"l"}, - Args: cobra.ExactValidArgs(1), + Args: cobra.MatchAll(cobra.ExactArgs(1)), Short: "Check for issues in recipes", Long: heredoc.Doc(` Check for issues specified recipes. diff --git a/cmd/list.go b/cmd/list.go index 2c1f44ea5..75bb75ce4 100644 --- a/cmd/list.go +++ b/cmd/list.go @@ -6,9 +6,9 @@ import ( "strings" "github.com/MakeNowJust/heredoc" - "github.com/odpf/meteor/registry" - "github.com/odpf/salt/printer" - "github.com/odpf/salt/term" + "github.com/raystack/meteor/registry" + "github.com/raystack/salt/printer" + "github.com/raystack/salt/term" "github.com/spf13/cobra" ) diff --git a/cmd/new.go b/cmd/new.go index 75b6933eb..b4eca8005 100644 --- a/cmd/new.go +++ b/cmd/new.go @@ -7,8 +7,8 @@ import ( "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc" - "github.com/odpf/meteor/generator" - "github.com/odpf/meteor/registry" + "github.com/raystack/meteor/generator" + "github.com/raystack/meteor/registry" "github.com/spf13/cobra" ) @@ -39,7 +39,7 @@ func NewRecipeCmd() *cobra.Command { cmd := &cobra.Command{ Use: "recipe [name]", Aliases: []string{"r"}, - Args: cobra.ExactValidArgs(1), + Args: cobra.MatchAll(cobra.ExactArgs(1)), Short: "Generate a new recipe", Long: heredoc.Doc(` Generate a new recipe. diff --git a/cmd/root.go b/cmd/root.go index fc68ad326..f88b27f53 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -2,7 +2,7 @@ package cmd import ( "github.com/MakeNowJust/heredoc" - "github.com/odpf/salt/cmdx" + "github.com/raystack/salt/cmdx" "github.com/spf13/cobra" ) @@ -23,10 +23,10 @@ func New() *cobra.Command { "group:core": "true", "help:learn": heredoc.Doc(` Use 'meteor --help' for more information about a command. - Read the manual at https://odpf.github.io/meteor/ + Read the manual at https://raystack.github.io/meteor/ `), "help:feedback": heredoc.Doc(` - Open an issue here https://github.com/odpf/meteor/issues + Open an issue here https://github.com/raystack/meteor/issues `), }, } diff --git a/cmd/run.go b/cmd/run.go index fa4e9995f..a9ee4098b 100644 --- a/cmd/run.go +++ b/cmd/run.go @@ -10,15 +10,15 @@ import ( "time" "github.com/MakeNowJust/heredoc" - "github.com/odpf/meteor/agent" - "github.com/odpf/meteor/config" - "github.com/odpf/meteor/metrics" - "github.com/odpf/meteor/plugins" - "github.com/odpf/meteor/recipe" - "github.com/odpf/meteor/registry" - "github.com/odpf/salt/log" - "github.com/odpf/salt/printer" - "github.com/odpf/salt/term" + "github.com/raystack/meteor/agent" + "github.com/raystack/meteor/config" + "github.com/raystack/meteor/metrics" + "github.com/raystack/meteor/plugins" + "github.com/raystack/meteor/recipe" + "github.com/raystack/meteor/registry" + "github.com/raystack/salt/log" + "github.com/raystack/salt/printer" + "github.com/raystack/salt/term" "github.com/schollz/progressbar/v3" "github.com/spf13/cobra" ) diff --git a/cmd/version.go b/cmd/version.go index 7c6e6a4bb..3ab898f04 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -3,8 +3,8 @@ package cmd import ( "fmt" - "github.com/odpf/salt/term" - "github.com/odpf/salt/version" + "github.com/raystack/salt/term" + "github.com/raystack/salt/version" "github.com/spf13/cobra" ) @@ -30,7 +30,7 @@ func VersionCmd() *cobra.Command { } fmt.Println(Version) - fmt.Println(term.Yellow(version.UpdateNotice(Version, "odpf/meteor"))) + fmt.Println(term.Yellow(version.UpdateNotice(Version, "raystack/meteor"))) return nil }, diff --git a/config/config.go b/config/config.go index ee9157256..6a30c1aba 100644 --- a/config/config.go +++ b/config/config.go @@ -4,7 +4,7 @@ import ( "errors" "fmt" - "github.com/odpf/salt/config" + "github.com/raystack/salt/config" ) // Config contains the configuration for meteor. diff --git a/docs/docs/contribute/contributing.md b/docs/docs/contribute/contributing.md index b765c7751..72c4bf0ab 100644 --- a/docs/docs/contribute/contributing.md +++ b/docs/docs/contribute/contributing.md @@ -4,34 +4,33 @@ We are always interested in adding new contributors. What we look for is a series of contributions, good taste, and an ongoing interest in the project. -* Committers will have write access to the Meteor repositories. -* There is no strict protocol for becoming a committer or PMC member. Candidates for new committers are typically people that are active contributors and community members. -* Candidates for new committers can also be suggested by current committers or PMC members. -* If you would like to become a committer, you should start contributing to Meteor in any of the ways mentioned. You might also want to talk to other committers and ask for their advice and guidance. +- Committers will have write access to the Meteor repositories. +- There is no strict protocol for becoming a committer or PMC member. Candidates for new committers are typically people that are active contributors and community members. +- Candidates for new committers can also be suggested by current committers or PMC members. +- If you would like to become a committer, you should start contributing to Meteor in any of the ways mentioned. You might also want to talk to other committers and ask for their advice and guidance. ## WHAT CAN YOU DO? -* You can report a bug or suggest a feature enhancement or can just ask questions. Reach out on Github discussions for this purpose. -* You can modify the code - * Add any new feature - * Add new metadata extractors - * Add new processors - * Add new sinks - * Improve Health and Monitoring Metrics - * Update deprecated libraries or tools -* You can help with documenting new features or improve existing documentation. -* You can also review and accept other contributions if you are a Commitor. +- You can report a bug or suggest a feature enhancement or can just ask questions. Reach out on Github discussions for this purpose. +- You can modify the code + - Add any new feature + - Add new metadata extractors + - Add new processors + - Add new sinks + - Improve Health and Monitoring Metrics + - Update deprecated libraries or tools +- You can help with documenting new features or improve existing documentation. +- You can also review and accept other contributions if you are a Commitor. ## GUIDELINES Please follow these practices for you change to get merged fast and smoothly: -* Contributions can only be accepted if they contain appropriate testing \(Unit and Integration Tests\). -* If you are introducing a completely new feature or making any major changes in an existing one, we recommend to start with an RFC and get consensus on the basic design first. -* Make sure your local build is running with all the tests and checkstyle passing. -* If your change is related to user-facing protocols / configurations, you need to make the corresponding change in the documentation as well. -* Docs live in the code repo under `docs` so that changes to that can be done in the same PR as changes to the code. -* Adding a new extractor should follow [this guide](https://github.com/odpf/meteor/tree/8cd8885b49271bd7aa5725101f9315278da646d2/docs/contribute/guide.md#adding-a-new-extractor). -* Adding a new processor should follow [this guide](https://github.com/odpf/meteor/tree/8cd8885b49271bd7aa5725101f9315278da646d2/docs/contribute/guide.md#adding-a-new-processor). -* Adding a new sink should follow [this guide](https://github.com/odpf/meteor/tree/8cd8885b49271bd7aa5725101f9315278da646d2/docs/contribute/guide.md#adding-a-new-sink). - +- Contributions can only be accepted if they contain appropriate testing \(Unit and Integration Tests\). +- If you are introducing a completely new feature or making any major changes in an existing one, we recommend to start with an RFC and get consensus on the basic design first. +- Make sure your local build is running with all the tests and checkstyle passing. +- If your change is related to user-facing protocols / configurations, you need to make the corresponding change in the documentation as well. +- Docs live in the code repo under `docs` so that changes to that can be done in the same PR as changes to the code. +- Adding a new extractor should follow [this guide](https://github.com/raystack/meteor/tree/8cd8885b49271bd7aa5725101f9315278da646d2/docs/contribute/guide.md#adding-a-new-extractor). +- Adding a new processor should follow [this guide](https://github.com/raystack/meteor/tree/8cd8885b49271bd7aa5725101f9315278da646d2/docs/contribute/guide.md#adding-a-new-processor). +- Adding a new sink should follow [this guide](https://github.com/raystack/meteor/tree/8cd8885b49271bd7aa5725101f9315278da646d2/docs/contribute/guide.md#adding-a-new-sink). diff --git a/docs/docs/contribute/guide.md b/docs/docs/contribute/guide.md index 6dfed0946..82b212c83 100644 --- a/docs/docs/contribute/guide.md +++ b/docs/docs/contribute/guide.md @@ -4,26 +4,25 @@ Please follow this list when adding a new Extractor: -* Create unit test for the new extractor. -* Register your extractor [here](https://github.com/odpf/meteor/tree/main/plugins/extractors/populate.go). This is also where you would inject any dependencies needed for your extractor. -* Create a markdown with your extractor details. \([example](https://github.com/odpf/meteor/tree/main/plugins/extractors/mysql/README.md)\) -* Add your extractor to one of the extractor list in `docs/reference/extractors.md`. +- Create unit test for the new extractor. +- Register your extractor [here](https://github.com/raystack/meteor/tree/main/plugins/extractors/populate.go). This is also where you would inject any dependencies needed for your extractor. +- Create a markdown with your extractor details. \([example](https://github.com/raystack/meteor/tree/main/plugins/extractors/mysql/README.md)\) +- Add your extractor to one of the extractor list in `docs/reference/extractors.md`. ## Adding a new Processor Please follow this list when adding a new Processor: -* Create unit test for the new processor. -* If the source instance is required for testing, Meteor provides a utility to easily create a docker container to help with your test as shown [here](https://github.com/odpf/meteor/tree/main/plugins/extractors/mysql/extractor_test.go#L35). -* Register your processor [here](https://github.com/odpf/meteor/tree/main/plugins/processors/populate.go). This is also where you would inject any dependencies needed for your processor. -* Update `docs/reference/processors.md` with guide to use the new processor. +- Create unit test for the new processor. +- If the source instance is required for testing, Meteor provides a utility to easily create a docker container to help with your test as shown [here](https://github.com/raystack/meteor/tree/main/plugins/extractors/mysql/extractor_test.go#L35). +- Register your processor [here](https://github.com/raystack/meteor/tree/main/plugins/processors/populate.go). This is also where you would inject any dependencies needed for your processor. +- Update `docs/reference/processors.md` with guide to use the new processor. ## Adding a new Sink Please follow this list when adding a new Sink: -* Create unit test for the new processor. -* If the source instance is required for testing, Meteor provides a utility to easily create a docker container to help with your test as shown [here](https://github.com/odpf/meteor/tree/main/plugins/extractors/mysql/extractor_test.go#L35). -* Register your sink [here](https://github.com/odpf/meteor/tree/main/plugins/sinks/populate.go). This is also where you would inject any dependencies needed for your sink. -* Update `docs/reference/sinks.md` with guide to use the new sink. - +- Create unit test for the new processor. +- If the source instance is required for testing, Meteor provides a utility to easily create a docker container to help with your test as shown [here](https://github.com/raystack/meteor/tree/main/plugins/extractors/mysql/extractor_test.go#L35). +- Register your sink [here](https://github.com/raystack/meteor/tree/main/plugins/sinks/populate.go). This is also where you would inject any dependencies needed for your sink. +- Update `docs/reference/sinks.md` with guide to use the new sink. diff --git a/docs/docs/guides/0_installation.md b/docs/docs/guides/0_installation.md index efe13f53a..8e7b3cf12 100644 --- a/docs/docs/guides/0_installation.md +++ b/docs/docs/guides/0_installation.md @@ -6,7 +6,7 @@ Meteor can be installed currently by one of the following ways: ```sh # install meteor (requires homebrew installed) -$ brew install odpf/tap/meteor +$ brew install raystack/tap/meteor # Get info about meteor $ meteor @@ -23,19 +23,19 @@ You have to add the meteor binary to the `PATH` environment variable yourself or Once installed, you should be able to run: -```$ meteor version``` +`$ meteor version` ## Using docker image ```bash # pull -$ docker pull odpf/meteor +$ docker pull raystack/meteor # Get info about commands -$ docker run --rm odpf/meteor +$ docker run --rm raystack/meteor # list down all the extractors currently supported -$ docker run --rm odpf/meteor meteor list extractors +$ docker run --rm raystack/meteor meteor list extractors ``` ## Build from source @@ -44,7 +44,7 @@ Requires you to have `git` and `golang (version 1.16 or above)` installed. ```bash #clone repo -$ git clone https://github.com/odpf/meteor.git +$ git clone https://github.com/raystack/meteor.git $ cd meteor @@ -53,4 +53,4 @@ $ make build $ ./meteor --help ``` -[github-releases]: https://github.com/odpf/meteor/releases +[github-releases]: https://github.com/raystack/meteor/releases diff --git a/docs/docs/guides/3_run_recipes.md b/docs/docs/guides/3_run_recipes.md index 59302f95e..956550b57 100644 --- a/docs/docs/guides/3_run_recipes.md +++ b/docs/docs/guides/3_run_recipes.md @@ -21,11 +21,11 @@ $ meteor run . ```bash # run meteor for specified recipes -$ docker run --rm odpf/meteor meteor run recipe.yml +$ docker run --rm raystack/meteor meteor run recipe.yml # run all recipes in the specified directory -$ docker run --rm odpf/meteor meteor run _recipes/ +$ docker run --rm raystack/meteor meteor run _recipes/ # run all recipes in the current directory -$ docker run --rm odpf/meteor meteor run . +$ docker run --rm raystack/meteor meteor run . ``` diff --git a/docs/docs/guides/4_deployment.md b/docs/docs/guides/4_deployment.md index 95173d5fe..97a294ebf 100644 --- a/docs/docs/guides/4_deployment.md +++ b/docs/docs/guides/4_deployment.md @@ -4,4 +4,4 @@ After we are done with running and verifying that the recipes works with the dat You may want to automate the process of metadata collection on some regular basis as a cron job. One can setup user for the same. -In ODPF we use helm chart to set it up, and you can refer the same [here](https://github.com/odpf/charts). +In raystack we use helm chart to set it up, and you can refer the same [here](https://github.com/raystack/charts). diff --git a/docs/docs/reference/configuration.md b/docs/docs/reference/configuration.md index 8efed29d5..9ee75bb3c 100644 --- a/docs/docs/reference/configuration.md +++ b/docs/docs/reference/configuration.md @@ -4,7 +4,7 @@ This page contains references for all the application configurations for Meteor. ## Table of Contents -* [Generic](configuration.md#generic) +- [Generic](configuration.md#generic) ## Generic @@ -12,15 +12,14 @@ Meteor's required variables to start using it. ### `PORT` -* Example value: `8080` -* Type: `optional` -* Default: `3000` -* Port to listen on. +- Example value: `8080` +- Type: `optional` +- Default: `3000` +- Port to listen on. ### `RECIPE_STORAGE_URL` -* Example value: `s3://my-bucket?region=us-west-1` -* Type: `optional` -* Default: `mem://` -* Object storage URL to persist recipes. Can be a gcs, an aws bucket or even a local folder. Check this [guide](https://github.com/odpf/meteor/tree/27f39fe2f83b657d4ecb9eb2c2a8794c6c0671b6/docs/guides/setup_storage.md) for url format and how to setup each available storage. - +- Example value: `s3://my-bucket?region=us-west-1` +- Type: `optional` +- Default: `mem://` +- Object storage URL to persist recipes. Can be a gcs, an aws bucket or even a local folder. Check this [guide](https://github.com/raystack/meteor/tree/27f39fe2f83b657d4ecb9eb2c2a8794c6c0671b6/docs/guides/setup_storage.md) for url format and how to setup each available storage. diff --git a/docs/docs/reference/extractors.md b/docs/docs/reference/extractors.md index 275c111a8..97a5d0045 100644 --- a/docs/docs/reference/extractors.md +++ b/docs/docs/reference/extractors.md @@ -11,73 +11,73 @@ that particular extractor can be found by visiting the link in the `type` field. ### Table | Type | Attributes | Profile | Schema | Lineage | Ownership | Custom | -|:----------------------------------|:-----------|:--------|:-------|:--------|:----------|:-------| -| [`clickhouse`][clickhouse-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`couchdb`][couchdb-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`mongodb`][mongodb-readme] | ✅ | ✅ | ✗ | ✗ | ✗ | ✗ | -| [`mssql`][mssql-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`mysql`][mysql-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`postgres`][postgres-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`cassandra`][cassandra-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`oracle`][oracle-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`mariadb`][mariadb-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`redshift`][redshift-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`presto`][presto-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`snowflake`][snowflake-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| :-------------------------------- | :--------- | :------ | :----- | :------ | :-------- | :----- | +| [`clickhouse`][clickhouse-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`couchdb`][couchdb-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`mongodb`][mongodb-readme] | ✅ | ✅ | ✗ | ✗ | ✗ | ✗ | +| [`mssql`][mssql-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`mysql`][mysql-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`postgres`][postgres-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`cassandra`][cassandra-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`oracle`][oracle-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`mariadb`][mariadb-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`redshift`][redshift-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`presto`][presto-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`snowflake`][snowflake-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | ✗ | ### Dashboard | Type | Url | Chart | Lineage | Tags | Custom | -|:------------------------------|:----|:------|:--------|:-----|:-------| -| [`grafana`][grafana-readme] | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`metabase`][metabase-readme] | ✅ | ✅ | ✗ | ✗ | ✗ | -| [`superset`][superset-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | -| [`tableau`][tableau-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | -| [`redash`][redash-readme] | ✅ | ✗ | ✗ | ✗ | ✗ | +| :---------------------------- | :-- | :---- | :------ | :--- | :----- | +| [`grafana`][grafana-readme] | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`metabase`][metabase-readme] | ✅ | ✅ | ✗ | ✗ | ✗ | +| [`superset`][superset-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | +| [`tableau`][tableau-readme] | ✅ | ✅ | ✅ | ✗ | ✗ | +| [`redash`][redash-readme] | ✅ | ✗ | ✗ | ✗ | ✗ | ### Topic | Type | Profile | Schema | Ownership | Lineage | Tags | Custom | -|:------------------------|:--------|:-------|:----------|:--------|:-----|:-------| +| :---------------------- | :------ | :----- | :-------- | :------ | :--- | :----- | | [`kafka`][kafka-readme] | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ### User | Type | Email | Username | FullName | Title | IsActive | ManagerEmail | Profiles | Memberships | facets | common | -|:--------------------------|:------|:---------|:---------|:------|:---------|:-------------|:---------|:------------|:-------|:-------| -| [`github`][github-readme] | ✅ | ✅ | ✅ | ✗ | ✅ | ✗ | ✗ | ✗ | ✗ | ✗ | -| [`shield`][shield-readme] | ✅ | ✅ | ✅ | ✗ | ✅ | ✗ | ✗ | ✅ | ✅ | ✗ | -| [`gsuite`][gsuite-readme] | ✅ | ✗ | ✅ | ✗ | ✅ | ✅ | ✗ | ✗ | ✗ | ✗ | +| :------------------------ | :---- | :------- | :------- | :---- | :------- | :----------- | :------- | :---------- | :----- | :----- | +| [`github`][github-readme] | ✅ | ✅ | ✅ | ✗ | ✅ | ✗ | ✗ | ✗ | ✗ | ✗ | +| [`shield`][shield-readme] | ✅ | ✅ | ✅ | ✗ | ✅ | ✗ | ✗ | ✅ | ✅ | ✗ | +| [`gsuite`][gsuite-readme] | ✅ | ✗ | ✅ | ✗ | ✅ | ✅ | ✗ | ✗ | ✗ | ✗ | ### Bucket | Type | Location | StorageType | Blobs | Ownership | Tags | Custom | Timestamps | -|:--------------------|:---------|:------------|:------|:----------|:-----|:-------|:-----------| -| [`gcs`][gcs-readme] | ✅ | ✅ | ✗ | ✅ | ✅ | ✗ | ✅ | +| :------------------ | :------- | :---------- | :---- | :-------- | :--- | :----- | :--------- | +| [`gcs`][gcs-readme] | ✅ | ✅ | ✗ | ✅ | ✅ | ✗ | ✅ | ### Job | Type | Ownership | Upstreams | Downstreams | Custom | -|:----------------------------|:----------|:----------|:------------|:-------| -| [`optimus`][optimus-readme] | ✅ | ✅ | ✅ | ✅ | ✅ | +| :-------------------------- | :-------- | :-------- | :---------- | :----- | --- | +| [`optimus`][optimus-readme] | ✅ | ✅ | ✅ | ✅ | ✅ | ### Machine Learning Feature Table | Type | Ownership | Upstreams | Downstreams | Custom | -|:------------------------------------|:----------|:----------|:------------|:-------| -| [`caramlstore`][caramlstore-readme] | ✗ | ✅ | ✗ | ✅ | +| :---------------------------------- | :-------- | :-------- | :---------- | :----- | +| [`caramlstore`][caramlstore-readme] | ✗ | ✅ | ✗ | ✅ | ### Application | Type | Ownership | Upstreams | Downstreams | Custom | -|:----------------------------------------------|:----------|:----------|:------------|:-------| -| [`application_yaml`][application-yaml-readme] | ✅ | ✅ | ✅ | ✅ | ✅ | +| :-------------------------------------------- | :-------- | :-------- | :---------- | :----- | --- | +| [`application_yaml`][application-yaml-readme] | ✅ | ✅ | ✅ | ✅ | ✅ | ### Machine Learning Model | Type | Ownership | Upstreams | Downstreams | Custom | -|:--------------------------|:----------|:----------|:------------|:-------| -| [`merlin`][merlin-readme] | ✅ | ✅ | ✗ | ✅ | ✅ | +| :------------------------ | :-------- | :-------- | :---------- | :----- | --- | +| [`merlin`][merlin-readme] | ✅ | ✅ | ✗ | ✅ | ✅ | ### Generic @@ -85,61 +85,35 @@ These are special type of extractors that are capable of extracting _any_ type of asset. | Type | Ownership | Upstreams | Downstreams | Custom | -|:----------------------|:----------|:----------|:------------|:-------| -| [`http`][http-readme] | ✅ | ✅ | ✅ | ✅ | ✅ | +| :-------------------- | :-------- | :-------- | :---------- | :----- | --- | +| [`http`][http-readme] | ✅ | ✅ | ✅ | ✅ | ✅ | -[clickhouse-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/clickhouse/README.md - -[couchdb-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/couchdb/README.md - -[mongodb-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/mongodb/README.md - -[mssql-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/mssql/README.md - -[mysql-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/mysql/README.md - -[postgres-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/postgres/README.md - -[cassandra-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/cassandra/README.md - -[oracle-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/oracle/README.md - -[mariadb-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/mariadb/README.md - -[redshift-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/redshift/README.md - -[presto-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/presto/README.md - -[snowflake-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/snowflake/README.md - -[grafana-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/grafana/README.md - -[metabase-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/metabase/README.md - -[superset-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/superset/README.md - -[tableau-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/tableau/README.md - -[redash-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/redash/README.md - -[kafka-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/kafka/README.md - -[github-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/github/README.md - -[shield-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/shield/README.md - -[gsuite-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/gsuite/README.md - -[gcs-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/gcs/README.md - -[optimus-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/optimus/README.md - -[caramlstore-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/caramlstore/README.md - -[application-yaml-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/application_yaml/README.md - -[merlin-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/merlin/README.md - -[http-readme]: https://github.com/odpf/meteor/tree/main/plugins/extractors/http/README.md +[clickhouse-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/clickhouse/README.md +[couchdb-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/couchdb/README.md +[mongodb-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/mongodb/README.md +[mssql-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/mssql/README.md +[mysql-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/mysql/README.md +[postgres-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/postgres/README.md +[cassandra-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/cassandra/README.md +[oracle-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/oracle/README.md +[mariadb-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/mariadb/README.md +[redshift-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/redshift/README.md +[presto-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/presto/README.md +[snowflake-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/snowflake/README.md +[grafana-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/grafana/README.md +[metabase-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/metabase/README.md +[superset-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/superset/README.md +[tableau-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/tableau/README.md +[redash-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/redash/README.md +[kafka-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/kafka/README.md +[github-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/github/README.md +[shield-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/shield/README.md +[gsuite-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/gsuite/README.md +[gcs-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/gcs/README.md +[optimus-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/optimus/README.md +[caramlstore-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/caramlstore/README.md +[application-yaml-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/application_yaml/README.md +[merlin-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/merlin/README.md +[http-readme]: https://github.com/raystack/meteor/tree/main/plugins/extractors/http/README.md diff --git a/docs/docs/reference/metadata_models.md b/docs/docs/reference/metadata_models.md index fa4298f00..6849a3874 100644 --- a/docs/docs/reference/metadata_models.md +++ b/docs/docs/reference/metadata_models.md @@ -68,12 +68,12 @@ implementation please refer [here][proton-assets]. ## Usage -[//]: # (@formatter:off) +[//]: # "@formatter:off" ```golang import( - assetsv1beta1 "github.com/odpf/meteor/models/odpf/assets/v1beta1" - "github.com/odpf/meteor/models/odpf/assets/facets/v1beta1" + assetsv1beta1 "github.com/raystack/meteor/models/raystack/assets/v1beta1" + "github.com/raystack/meteor/models/raystack/assets/facets/v1beta1" ) func main(){ @@ -99,25 +99,14 @@ func main(){ } ``` -[//]: # (@formatter:on) - - -[proton-bucket]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/bucket.proto - -[proton-dashboard]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/dashboard.proto - -[proton-user]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/user.proto - -[proton-table]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/table.proto - -[proton-job]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/job.proto - -[proton-topic]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/topic.proto - -[proton-featuretable]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/feature_table.proto - -[proton-application]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/application.proto - -[proton-model]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2/model.proto - -[proton-assets]: https://github.com/odpf/proton/tree/main/odpf/assets/v1beta2 +[//]: # "@formatter:on" +[proton-bucket]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/bucket.proto +[proton-dashboard]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/dashboard.proto +[proton-user]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/user.proto +[proton-table]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/table.proto +[proton-job]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/job.proto +[proton-topic]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/topic.proto +[proton-featuretable]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/feature_table.proto +[proton-application]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/application.proto +[proton-model]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2/model.proto +[proton-assets]: https://github.com/raystack/proton/tree/main/raystack/assets/v1beta2 diff --git a/docs/docs/reference/processors.md b/docs/docs/reference/processors.md index 452230108..445a5f6a4 100644 --- a/docs/docs/reference/processors.md +++ b/docs/docs/reference/processors.md @@ -38,8 +38,6 @@ engine. [More details][script-readme] -[labels-readme]: https://github.com/odpf/meteor/blob/main/plugins/processors/labels/README.md - -[script-readme]: https://github.com/odpf/meteor/blob/main/plugins/processors/script/README.md - +[labels-readme]: https://github.com/raystack/meteor/blob/main/plugins/processors/labels/README.md +[script-readme]: https://github.com/raystack/meteor/blob/main/plugins/processors/script/README.md [tengo]: https://github.com/d5/tengo diff --git a/docs/docs/reference/sinks.md b/docs/docs/reference/sinks.md index 9159b1ed6..324eb632c 100644 --- a/docs/docs/reference/sinks.md +++ b/docs/docs/reference/sinks.md @@ -10,27 +10,27 @@ Print data to stdout. ```yaml sinks: - - name: console + - name: console ``` ## Compass `compass` -Upload metadata to a given `type` in [Compass](https://github.com/odpf/meteor/tree/cb12c3ecf8904cf3f4ce365ca8981ccd132f35d0/docs/reference/github.com/odpf/compass/README.md). Request will be sent via HTTP to a given host. +Upload metadata to a given `type` in [Compass](https://github.com/raystack/meteor/tree/cb12c3ecf8904cf3f4ce365ca8981ccd132f35d0/docs/reference/github.com/raystack/compass/README.md). Request will be sent via HTTP to a given host. ### Sample usage of compass sink ```yaml sinks: - - name: compass - config: - host: https://compass.com - type: sample-compass-type - mapping: - new_fieldname: "json_field_name" - id: "resource.urn" - displayName: "resource.name" + - name: compass + config: + host: https://compass.com + type: sample-compass-type + mapping: + new_fieldname: "json_field_name" + id: "resource.urn" + displayName: "resource.name" ``` ## File @@ -41,11 +41,12 @@ Sinks metadata to a file in `json/yaml` format as per the config defined. ```yaml sinks: - name: file - config: - path: "./dir/sample.yaml" - format: "yaml" + name: file + config: + path: "./dir/sample.yaml" + format: "yaml" ``` + ## GCS `Google Cloud Storage` @@ -56,22 +57,22 @@ Sinks json data to a file as ndjson format in Google Cloud Storage bucket sinks: - name: gcs config: - project_id: google-project-id - url: gcs://bucket_name/target_folder - object_prefix : github-users - service_account_base64: - service_account_json: - { - "type": "service_account", - "private_key_id": "xxxxxxx", - "private_key": "xxxxxxx", - "client_email": "xxxxxxx", - "client_id": "xxxxxxx", - "auth_uri": "https://accounts.google.com/o/oauth2/auth", - "token_uri": "https://oauth2.googleapis.com/token", - "auth_provider_x509_cert_url": "xxxxxxx", - "client_x509_cert_url": "xxxxxxx", - } + project_id: google-project-id + url: gcs://bucket_name/target_folder + object_prefix: github-users + service_account_base64: + service_account_json: + { + "type": "service_account", + "private_key_id": "xxxxxxx", + "private_key": "xxxxxxx", + "client_email": "xxxxxxx", + "client_id": "xxxxxxx", + "auth_uri": "https://accounts.google.com/o/oauth2/auth", + "token_uri": "https://oauth2.googleapis.com/token", + "auth_provider_x509_cert_url": "xxxxxxx", + "client_x509_cert_url": "xxxxxxx", + } ``` ## http @@ -95,7 +96,7 @@ sinks: `stencil` -Upload metadata of a given schema `format` in the existing `namespace_id` present in [Stencil](https://github.com/odpf/meteor/tree/cb12c3ecf8904cf3f4ce365ca8981ccd132f35d0/docs/reference/github.com/odpf/stencil/README.md). Request will be sent via HTTP to a given host. +Upload metadata of a given schema `format` in the existing `namespace_id` present in [Stencil](https://github.com/raystack/meteor/tree/cb12c3ecf8904cf3f4ce365ca8981ccd132f35d0/docs/reference/github.com/raystack/stencil/README.md). Request will be sent via HTTP to a given host. ```yaml sinks: @@ -120,7 +121,7 @@ sinks: config: host: shield.com headers: - X-Shield-Email: meteor@odpf.io + X-Shield-Email: meteor@raystack.io X-Other-Header: value1, value2 ``` diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index eebf3c718..bb729bc72 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -6,12 +6,12 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); (module.exports = { title: 'Meteor', tagline: 'Metadata collection framework', - url: 'https://odpf.github.io/', + url: 'https://raystack.github.io/', baseUrl: '/meteor/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', favicon: 'img/favicon.ico', - organizationName: 'ODPF', + organizationName: 'raystack', projectName: 'meteor', presets: [ @@ -20,7 +20,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); ({ docs: { sidebarPath: require.resolve('./sidebars.js'), - editUrl: 'https://github.com/odpf/meteor/edit/master/docs/', + editUrl: 'https://github.com/raystack/meteor/edit/master/docs/', sidebarCollapsed: false, }, blog: false, @@ -61,7 +61,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); className: 'header-slack-link', }, { - href: 'https://github.com/odpf/meteor', + href: 'https://github.com/raystack/meteor', className: 'navbar-item-github', position: 'right', }, @@ -73,10 +73,10 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); { title: 'Products', items: [ - { label: 'Optimus', href: 'https://github.com/odpf/optimus' }, - { label: 'Firehose', href: 'https://github.com/odpf/firehose' }, - { label: 'Raccoon', href: 'https://github.com/odpf/raccoon' }, - { label: 'Dagger', href: 'https://odpf.github.io/dagger/' }, + { label: 'Optimus', href: 'https://github.com/raystack/optimus' }, + { label: 'Firehose', href: 'https://github.com/raystack/firehose' }, + { label: 'Raccoon', href: 'https://github.com/raystack/raccoon' }, + { label: 'Dagger', href: 'https://raystack.github.io/dagger/' }, ], }, { @@ -90,7 +90,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); title: 'Community', items: [ { label: 'Slack', href: 'https://bit.ly/2RzPbtn' }, - { label: 'GitHub', href: 'https://github.com/odpf/meteor' } + { label: 'GitHub', href: 'https://github.com/raystack/meteor' } ], }, ], @@ -101,7 +101,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); }, announcementBar: { id: 'star-repo', - content: '⭐️ If you like Meteor, give it a star on GitHub! ⭐', + content: '⭐️ If you like Meteor, give it a star on GitHub! ⭐', backgroundColor: '#222', textColor: '#eee', isCloseable: true, diff --git a/docs/src/pages/help.js b/docs/src/pages/help.js index 0b0f2f7d4..2f5f6ba8c 100644 --- a/docs/src/pages/help.js +++ b/docs/src/pages/help.js @@ -25,7 +25,7 @@ export default function Home() {
The Meteor team has an open source slack workspace to discuss development and support. Most of the Meteor discussions happen in #meteor channel. -
Join us on Slack +
Join us on Slack
) }, { @@ -33,7 +33,7 @@ export default function Home() { content: (
Have a general issue or bug that you've found? We'd love to hear about it in our GitHub issues. This can be feature requests too! -
Go to issues +
Go to issues
) }, @@ -42,7 +42,7 @@ export default function Home() { content: (
For help and questions about best practices, join our GitHub discussions. Browse and ask questions. -
Go to discussions +
Go to discussions
) } diff --git a/docs/static/assets/overview.svg b/docs/static/assets/overview.svg index c97da9d94..f0acd91a8 100644 --- a/docs/static/assets/overview.svg +++ b/docs/static/assets/overview.svg @@ -26,8 +26,8 @@ - - + + diff --git a/docs/static/img/banner.svg b/docs/static/img/banner.svg index ac0563a1b..906a97b6a 100644 --- a/docs/static/img/banner.svg +++ b/docs/static/img/banner.svg @@ -1,4 +1,4 @@ -