Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/content/en/docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,3 @@ Currently, PipeCD is supporting these four cloud providers: `KUBERNETES`, `TERRA

PipeCD supports multiple methods to automate the analysis process of the deployment. It can be done by using metrics, logs or by checking the configured http requests.
Analysis Provider defines where to get those metrics/log data, like `Prometheus`, `Datadog`, `Stackdriver`, `CloudWatch`, and so on.

### Image Provider

PipeCD can automatically trigger a new Deployment when a new image tag stored at a container registry is pushed by enabling the [Image watcher](/docs/user-guide/image-watcher) feature.
Image Provider defines which container registry should be monitored.
Currently, PipeCD is supporting only `ECR`. `GCR` and `DOCKERHUB` are on the roadmap.
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ spec:
| chartRepositories | [][ChartRepository](/docs/operator-manual/piped/configuration-reference/#chartrepository) | List of Helm chart repositories that should be added while starting up. | No |
| cloudProviders | [][CloudProvider](/docs/operator-manual/piped/configuration-reference/#cloudprovider) | List of cloud providers can be used by this piped. | No |
| analysisProviders | [][AnalysisProvider](/docs/operator-manual/piped/configuration-reference/#analysisprovider) | List of analysis providers can be used by this piped. | No |
| imageProviders | [][ImageProvider](/docs/operator-manual/piped/configuration-reference/#imageprovider) | List of image providers can be used by this piped. | No |
| imageWatcher | [ImageWatcher](/docs/operator-manual/piped/configuration-reference/#imagewatcher) | Optional Image watcher settings for each git repository | No |
| eventWatcher | [EventWatcher](/docs/operator-manual/piped/configuration-reference/#eventwatcher) | Optional Event watcher settings | No |
| notifications | [Notifications](/docs/operator-manual/piped/configuration-reference/#notifications) | Sending notifications to Slack, Webhook... | No |

Expand Down Expand Up @@ -137,49 +135,6 @@ Must be one of the following structs:
| usernameFile | string | The path to the username file. | No |
| passwordFile | string | The path to the password file. | No |

## ImageProvider

| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the analysis provider. | Yes |
| type | string | The provider type. Currently, `GCR` and `ECR` are available. | Yes |
| config | [ImageProviderConfig](/docs/operator-manual/piped/configuration-reference/#imageproviderconfig) | Specific configuration for the specified type of image provider. | Yes |

## ImageProviderConfig

Must be one of the following structs:

### ImageProviderGCRConfig

| Field | Type | Description | Required |
|-|-|-|-|
| serviceAccountFile | string | The path to the json file of service account with the required `roles/storage.objectViewer` role. | No |

### ImageProviderECRConfig

| Field | Type | Description | Required |
|-|-|-|-|
| region | string | The region to send requests to. This parameter is required. e.g. "us-west-2". A full list of regions is: https://docs.aws.amazon.com/general/latest/gr/rande.html | Yes |
| registryId | string | The AWS account ID associated with the registry that contains the repository in which to list images. The "default" registry is assumed by default. | No |
| credentialsFile | string | Path to the shared credentials file. | No |
| profile | string | AWS Profile to extract credentials from the shared credentials file. If empty, the environment variable "AWS_PROFILE" is used. "default" is populated if the environment variable is also not set. | No |

## ImageWatcher

| Field | Type | Description | Required |
|-|-|-|-|
| checkInterval | duration | Interval to compare the image in the git repository and one in the images provider. Defaults to `5m`. | No |
| gitRepos | [][ImageWatcherGitRepo](/docs/operator-manual/piped/configuration-reference/#imagewatchergitrepo) | List of settings for each git repository | No |

### ImageWatcherGitRepo

| Field | Type | Description | Required |
|-|-|-|-|
| repoId | string | Id of the git repository. This must be unique within the repos' elements. | Yes |
| commitMessage | string | The commit message used to push after updating image. Default message is used if not given. | No |
| includes | []string | The paths to ImageWatcher files to be included. | No |
| excludes | []string | The paths to ImageWatcher files to be excluded. This is prioritized if both includes and this are given. | No |

## EventWatcher

| Field | Type | Description | Required |
Expand Down

This file was deleted.

26 changes: 0 additions & 26 deletions docs/content/en/docs/user-guide/configuration-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,32 +110,6 @@ spec:
|-|-|-|-|
| metrics | map[string][AnalysisMetrics](/docs/user-guide/configuration-reference/#analysismetrics) | Template for metrics. | No |

## Image Watcher Configuration

```yaml
apiVersion: pipecd.dev/v1beta1
kind: ImageWatcher
spec:
targets:
- image: gcr.io/pipecd/helloworld
provider: my-gcr
filePath: foo/deployment.yaml
field: $.spec.template.spec.containers[0].image
```

| Field | Type | Description | Required |
|-|-|-|-|
| targets | [][ImageWatcherTarget](/docs/user-guide/configuration-reference/#imagewatchertarget) | Target images to be watched. | No |

## ImageWatcherTarget

| Field | Type | Description | Required |
|-|-|-|-|
| image | string | Fully qualified image name. | Yes |
| provider | string | The name of Image provider that must be configured in the piped config. See [here](/docs/operator-manual/piped/configuration-reference/#imageprovider) for more details. | Yes |
| filePath | string | The path to the file to be updated. | Yes |
| field | string | The path to the field to be updated. It requires to start with `$` which represents the root element. e.g. `$.foo.bar[0].baz`. | Yes |

## Event Watcher Configuration

```yaml
Expand Down
78 changes: 0 additions & 78 deletions docs/content/en/docs/user-guide/image-watcher.md

This file was deleted.

12 changes: 0 additions & 12 deletions examples/.pipe/image-watcher.yaml

This file was deleted.

1 change: 0 additions & 1 deletion pkg/app/piped/cmd/piped/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ go_library(
"//pkg/app/piped/driftdetector:go_default_library",
"//pkg/app/piped/eventwatcher:go_default_library",
"//pkg/app/piped/executor/registry:go_default_library",
"//pkg/app/piped/imagewatcher:go_default_library",
"//pkg/app/piped/livestatereporter:go_default_library",
"//pkg/app/piped/livestatestore:go_default_library",
"//pkg/app/piped/notifier:go_default_library",
Expand Down
13 changes: 0 additions & 13 deletions pkg/app/piped/cmd/piped/piped.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ import (
"github.com/pipe-cd/pipe/pkg/app/piped/controller"
"github.com/pipe-cd/pipe/pkg/app/piped/driftdetector"
"github.com/pipe-cd/pipe/pkg/app/piped/eventwatcher"
"github.com/pipe-cd/pipe/pkg/app/piped/imagewatcher"
"github.com/pipe-cd/pipe/pkg/app/piped/livestatereporter"
"github.com/pipe-cd/pipe/pkg/app/piped/livestatestore"
"github.com/pipe-cd/pipe/pkg/app/piped/notifier"
Expand Down Expand Up @@ -339,18 +338,6 @@ func (p *piped) run(ctx context.Context, t cli.Telemetry) (runErr error) {
})
}

if len(cfg.ImageProviders) > 0 {
// Start running image watcher.
t := imagewatcher.NewWatcher(
cfg,
gitClient,
t.Logger,
)
group.Go(func() error {
return t.Run(ctx)
})
}

{
// Start running event watcher.
t := eventwatcher.NewWatcher(
Expand Down
14 changes: 0 additions & 14 deletions pkg/app/piped/imageprovider/BUILD.bazel

This file was deleted.

26 changes: 0 additions & 26 deletions pkg/app/piped/imageprovider/ecr/BUILD.bazel

This file was deleted.

Loading