-
Notifications
You must be signed in to change notification settings - Fork 141
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into feat/add-pat-setting
- Loading branch information
Showing
297 changed files
with
47,136 additions
and
10 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
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,35 @@ | ||
| // Copyright 2024 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "log" | ||
|
|
||
| "github.com/pipe-cd/pipecd/pkg/app/pipedv1/cmd/piped" | ||
| "github.com/pipe-cd/pipecd/pkg/cli" | ||
| ) | ||
|
|
||
| func main() { | ||
| app := cli.NewApp( | ||
| "piped", | ||
| "A component that runs inside target environment to execute deployment and report its state.", | ||
| ) | ||
| app.AddCommands( | ||
| piped.NewCommand(), | ||
| ) | ||
| if err := app.Run(); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| } |
87 changes: 87 additions & 0 deletions
87
docs/content/en/blog/control-plane-local-docker-compose.md
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,87 @@ | ||
| --- | ||
| date: 2024-03-14 | ||
| title: "Control Plane on local by docker-compose" | ||
| linkTitle: "Control Plane on local by docker-compose" | ||
| weight: 989 | ||
| description: "This blog shows you how to install a PipeCD Control Plane on local machine easily." | ||
| author: Tetsuya Kikuchi ([@t-kikuc](https://github.com/t-kikuc)) | ||
| --- | ||
|
|
||
| Currently, you can deploy and operate a PipeCD Control Plane on a Kubernetes cluster or [on Amazon ECS](./control-plane-on-ecs.md). | ||
| However, some developers would like to build a Control Plane more easily for introduction or development. | ||
| This blog shows you how to install a PipeCD Control Plane on local machine easily. | ||
|
|
||
| This blog is for those who would like to: | ||
| - begin using PipeCD and experiment its features instantly, including Control Plane and Piped | ||
|
|
||
| ### Architecture | ||
|
|
||
| The general architecture of PipeCD Control Plane is as below. | ||
|  | ||
|
|
||
| > Note: See [Architecture Overview](docs/user-guide/managing-controlplane/architecture-overview/) doc for details. | ||
| In this blog, you will build a Control Plane by these containers: | ||
|
|
||
| - Server: pipecd server | ||
| - Ops: pipecd ops | ||
| - Cache: Redis | ||
| - Data Store: MySQL | ||
| - File Store: MinIO | ||
|
|
||
| ### Installation of Control Plane | ||
|
|
||
| 1. Get the demo codes from https://github.com/pipe-cd/demo/blob/main/control_plane/docker-compose/ | ||
|
|
||
| 2. Execute the below command for docker-compose.yaml you got in [1.]. | ||
|
|
||
| ```sh | ||
| docker-compose up | ||
| ``` | ||
|
|
||
| After executing the above command, you will see logs like below if success. | ||
|
|
||
| ```log | ||
| pipecd-server-1 | successfully loaded control-plane configuration | ||
| pipecd-server-1 | successfully connected to file store | ||
| pipecd-server-1 | successfully connected to data store | ||
| pipecd-server-1 | grpc server will be run without tls | ||
| pipecd-server-1 | grpc server will be run without tls | ||
| pipecd-server-1 | grpc server is running on [::]:9080 | ||
| pipecd-server-1 | grpc server is running on [::]:9083 | ||
| pipecd-server-1 | grpc server will be run without tls | ||
| pipecd-server-1 | admin server is running on 9085 | ||
| pipecd-server-1 | grpc server is running on [::]:9081 | ||
| pipecd-server-1 | start running http server on :9082 | ||
| ``` | ||
|
|
||
| ### To confirm: Access the console of the Control Plane | ||
|
|
||
| 1. Access http://localhost:8080 on your web browser. | ||
|
|
||
| 2. Enter a value as below and `CONTINUE`. | ||
| - `Project Name`: `control-plane-local` | ||
|
|
||
| 3. Enter values as below and `LOGIN`. | ||
| - `Username`: `hello-pipecd` | ||
| - `Password`: `hello-pipecd` | ||
|
|
||
| 4. You will see the applications page. Success! | ||
|
|
||
|  | ||
|
|
||
| ### Clean up | ||
|
|
||
| To clean up the Control Plane, execute the below command. | ||
|
|
||
| ```sh | ||
| docker-compose down | ||
| ``` | ||
|
|
||
| > Note: By following commands instead of above one, you can keep data such as Piped or applications on the Control Plane even after restarting/updating the server component. | ||
| ```sh | ||
| # Restart only the server component. | ||
| docker-compose rm -fsv pipecd-server | ||
| docker-compose up pipecd-server | ||
| ``` |
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
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,80 @@ | ||
| // Copyright 2024 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // Package http provides a way to analyze with http requests. | ||
| // This allows you to do smoke tests, load tests and so on, at your leisure. | ||
| package http | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/pipe-cd/pipecd/pkg/config" | ||
| ) | ||
|
|
||
| const ( | ||
| ProviderType = "HTTP" | ||
| defaultTimeout = 30 * time.Second | ||
| ) | ||
|
|
||
| type Provider struct { | ||
| client *http.Client | ||
| } | ||
|
|
||
| func (p *Provider) Type() string { | ||
| return ProviderType | ||
| } | ||
|
|
||
| func NewProvider(timeout time.Duration) *Provider { | ||
| if timeout == 0 { | ||
| timeout = defaultTimeout | ||
| } | ||
| return &Provider{ | ||
| client: &http.Client{Timeout: timeout}, | ||
| } | ||
| } | ||
|
|
||
| // Run sends an HTTP request and then evaluate whether the response is expected one. | ||
| func (p *Provider) Run(ctx context.Context, cfg *config.AnalysisHTTP) (bool, string, error) { | ||
| req, err := p.makeRequest(ctx, cfg) | ||
| if err != nil { | ||
| return false, "", err | ||
| } | ||
|
|
||
| res, err := p.client.Do(req) | ||
| if err != nil { | ||
| return false, "", err | ||
| } | ||
| defer res.Body.Close() | ||
|
|
||
| if res.StatusCode != cfg.ExpectedCode { | ||
| return false, "", fmt.Errorf("unexpected status code %d", res.StatusCode) | ||
| } | ||
| // TODO: Decide how to check if the body is expected one. | ||
| return true, "", nil | ||
| } | ||
|
|
||
| func (p *Provider) makeRequest(ctx context.Context, cfg *config.AnalysisHTTP) (*http.Request, error) { | ||
| req, err := http.NewRequestWithContext(ctx, cfg.Method, cfg.URL, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| req.Header = make(http.Header, len(cfg.Headers)) | ||
| for _, h := range cfg.Headers { | ||
| req.Header.Set(h.Key, h.Value) | ||
| } | ||
| return req, nil | ||
| } |
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,47 @@ | ||
| // Copyright 2024 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package factory | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "go.uber.org/zap" | ||
|
|
||
| "github.com/pipe-cd/pipecd/pkg/app/piped/analysisprovider/log" | ||
| "github.com/pipe-cd/pipecd/pkg/app/piped/analysisprovider/log/stackdriver" | ||
| "github.com/pipe-cd/pipecd/pkg/config" | ||
| "github.com/pipe-cd/pipecd/pkg/model" | ||
| ) | ||
|
|
||
| // NewProvider generates an appropriate provider according to analysis provider config. | ||
| func NewProvider(providerCfg *config.PipedAnalysisProvider, logger *zap.Logger) (provider log.Provider, err error) { | ||
| switch providerCfg.Type { | ||
| case model.AnalysisProviderStackdriver: | ||
| cfg := providerCfg.StackdriverConfig | ||
| sa, err := os.ReadFile(cfg.ServiceAccountFile) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| provider, err = stackdriver.NewProvider(sa) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| default: | ||
| return nil, fmt.Errorf("any of providers config not found") | ||
| } | ||
| return provider, nil | ||
| } |
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,28 @@ | ||
| // Copyright 2024 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package log | ||
|
|
||
| import ( | ||
| "context" | ||
| ) | ||
|
|
||
| // Provider represents a client for log provider which provides logs for analysis. | ||
| type Provider interface { | ||
| Type() string | ||
| // Evaluate runs the given query against the log provider, | ||
| // and then checks if there is at least one error log. | ||
| // Returns the result reason if non-error occurred. | ||
| Evaluate(ctx context.Context, query string) (result bool, reason string, err error) | ||
| } |
Oops, something went wrong.