Remove unused docs #4082
Merged
Remove unused docs #4082
Conversation
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
knanao
approved these changes
Dec 16, 2022
Comment on lines
83
to
+85
| ## CloudProvider | ||
|
|
||
| | Field | Type | Description | Required | | ||
| |-|-|-|-| | ||
| | name | string | The name of the cloud provider. | Yes | | ||
| | type | string | The cloud provider type. Must be one of the following values:<br>`KUBERNETES`, `TERRAFORM`, `CLOUDRUN`, `LAMBDA`. | Yes | | ||
| | config | [CloudProviderConfig](#cloudproviderconfig) | Specific configuration for the specified type of cloud provider. | No | | ||
|
|
||
| ## CloudProviderConfig | ||
|
|
||
| Must be one of the following structs: | ||
|
|
||
| ### CloudProviderKubernetesConfig | ||
|
|
||
| | Field | Type | Description | Required | | ||
| |-|-|-|-| | ||
| | masterURL | string | The master URL of the kubernetes cluster. Empty means in-cluster. | No | | ||
| | kubeConfigPath | string | The path to the kubeconfig file. Empty means in-cluster. | No | | ||
| | appStateInformer | [KubernetesAppStateInformer](#kubernetesappstateinformer) | Configuration for application resource informer. | No | | ||
|
|
||
| ### CloudProviderTerraformConfig | ||
|
|
||
| | Field | Type | Description | Required | | ||
| |-|-|-|-| | ||
| | vars | []string | List of variables that will be set directly on terraform commands with `-var` flag. The variable must be formatted by `key=value`. | No | | ||
|
|
||
| ### CloudProviderCloudRunConfig | ||
|
|
||
| | Field | Type | Description | Required | | ||
| |-|-|-|-| | ||
| | project | string | The GCP project hosting the Cloud Run service. | Yes | | ||
| | region | string | The region of running Cloud Run service. | Yes | | ||
| | credentialsFile | string | The path to the service account file for accessing Cloud Run service. | No | | ||
|
|
||
| ### CloudProviderLambdaConfig | ||
|
|
||
| | Field | Type | Description | Required | | ||
| |-|-|-|-| | ||
| | region | string | The region of running Lambda service. | Yes | | ||
| | credentialsFile | string | The path to the credential file for logging into AWS cluster. If this value is not provided, piped will read credential info from environment variables. It expects the format [~/.aws/credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). | No | | ||
| | roleARN | string | The IAM role arn to use when assuming an role. Required if you want to use the AWS SecurityTokenService. | No | | ||
| | tokenFile | string | The path to the WebIdentity token the SDK should use to assume a role with. Required if you want to use the AWS SecurityTokenService. | No | | ||
| | profile | string | The profile to use for logging into AWS cluster. The default value is `default`. | No | | ||
|
|
||
| ### CloudProviderECSConfig | ||
|
|
||
| | Field | Type | Description | Required | | ||
| |-|-|-|-| | ||
| | region | string | The region of running ECS cluster. | Yes | | ||
| | credentialsFile | string | The path to the credential file for logging into AWS cluster. If this value is not provided, piped will read credential info from environment variables. It expects the format [~/.aws/credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) | No | | ||
| | roleARN | string | The IAM role arn to use when assuming an role. Required if you want to use the AWS SecurityTokenService. | No | | ||
| | tokenFile | string | The path to the WebIdentity token the SDK should use to assume a role with. Required if you want to use the AWS SecurityTokenService. | No | | ||
| | profile | string | The profile to use for logging into AWS cluster. The default value is `default`. | No | | ||
| This field is deprecated, please use [PlatformProvider](#platformprovider) instead. |
There was a problem hiding this comment.
This seems not to be necessary because we already mention this.
https://github.com/pipe-cd/pipecd/pull/4082/files#diff-cda66baafdfb61c1ac72ad0820325e806da1e2608cc9f64069b7b84abe967abbR33
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: