-
Notifications
You must be signed in to change notification settings - Fork 319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update cloud-provider-aws docs #21
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,67 @@ | ||
{ | ||
"Statement": [ | ||
{ | ||
"Action": [ | ||
"autoscaling:DescribeAutoScalingGroups", | ||
"autoscaling:DescribeLaunchConfigurations", | ||
"autoscaling:DescribeTags", | ||
"ec2:DescribeInstances", | ||
"ec2:DescribeRegions", | ||
"ec2:DescribeRouteTables", | ||
"ec2:DescribeSecurityGroups", | ||
"ec2:DescribeSubnets", | ||
"ec2:DescribeVolumes", | ||
"ec2:CreateSecurityGroup", | ||
"ec2:CreateTags", | ||
"ec2:CreateVolume", | ||
"ec2:ModifyInstanceAttribute", | ||
"ec2:ModifyVolume", | ||
"ec2:AttachVolume", | ||
"ec2:AuthorizeSecurityGroupIngress", | ||
"ec2:CreateRoute", | ||
"ec2:DeleteRoute", | ||
"ec2:DeleteSecurityGroup", | ||
"ec2:DeleteVolume", | ||
"ec2:DetachVolume", | ||
"ec2:RevokeSecurityGroupIngress", | ||
"ec2:DescribeVpcs", | ||
"elasticloadbalancing:AddTags", | ||
"elasticloadbalancing:AttachLoadBalancerToSubnets", | ||
"elasticloadbalancing:ApplySecurityGroupsToLoadBalancer", | ||
"elasticloadbalancing:CreateLoadBalancer", | ||
"elasticloadbalancing:CreateLoadBalancerPolicy", | ||
"elasticloadbalancing:CreateLoadBalancerListeners", | ||
"elasticloadbalancing:ConfigureHealthCheck", | ||
"elasticloadbalancing:DeleteLoadBalancer", | ||
"elasticloadbalancing:DeleteLoadBalancerListeners", | ||
"elasticloadbalancing:DescribeLoadBalancers", | ||
"elasticloadbalancing:DescribeLoadBalancerAttributes", | ||
"elasticloadbalancing:DetachLoadBalancerFromSubnets", | ||
"elasticloadbalancing:DeregisterInstancesFromLoadBalancer", | ||
"elasticloadbalancing:ModifyLoadBalancerAttributes", | ||
"elasticloadbalancing:RegisterInstancesWithLoadBalancer", | ||
"elasticloadbalancing:SetLoadBalancerPoliciesForBackendServer", | ||
"elasticloadbalancing:AddTags", | ||
"elasticloadbalancing:CreateListener", | ||
"elasticloadbalancing:CreateTargetGroup", | ||
"elasticloadbalancing:DeleteListener", | ||
"elasticloadbalancing:DeleteTargetGroup", | ||
"elasticloadbalancing:DescribeListeners", | ||
"elasticloadbalancing:DescribeLoadBalancerPolicies", | ||
"elasticloadbalancing:DescribeTargetGroups", | ||
"elasticloadbalancing:DescribeTargetHealth", | ||
"elasticloadbalancing:ModifyListener", | ||
"elasticloadbalancing:ModifyTargetGroup", | ||
"elasticloadbalancing:RegisterTargets", | ||
"elasticloadbalancing:SetLoadBalancerPoliciesOfListener", | ||
"iam:CreateServiceLinkedRole", | ||
"kms:DescribeKey" | ||
], | ||
"Effect": "Allow", | ||
"Resource": [ | ||
"*" | ||
] | ||
} | ||
], | ||
"Version": "2012-10-17" | ||
} |
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,20 @@ | ||
{ | ||
"Version": "2012-10-17", | ||
"Statement": [ | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"ec2:DescribeInstances", | ||
"ec2:DescribeRegions", | ||
"ecr:GetAuthorizationToken", | ||
"ecr:BatchCheckLayerAvailability", | ||
"ecr:GetDownloadUrlForLayer", | ||
"ecr:GetRepositoryPolicy", | ||
"ecr:DescribeRepositories", | ||
"ecr:ListImages", | ||
"ecr:BatchGetImage" | ||
], | ||
"Resource": "*" | ||
} | ||
] | ||
} |
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,40 @@ | ||
# Amazon Cloud Controller Manager | ||
**NOTE:** This cloud controller manager functionality is currently in ALPHA testing stage. There maybe be potentially backwards compatibility breaking changes moving forward and there may also be bugs. Please test and report bugs but do NOT use this in a production environment. | ||
|
||
The AWS cloud controller manager provides the interface between a Kubernetes cluster and AWS service APIs. This project allows a Kubernetes cluster to provision, monitor and remove resources necessary for operation of the cluster. | ||
|
||
For general cloud controller manager setup instructions see the [Kubernetes Cloud Controller Manager docs](https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/). | ||
|
||
For more details about cloud controller managers see: | ||
|
||
* [KEP 0002: Remove Cloud Provider Code From Kubernetes Core](https://github.com/kubernetes/community/blob/master/keps/sig-cloud-provider/0002-cloud-controller-manager.md) | ||
* [Running Cloud Controller Manager](https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager) | ||
* [Developing Cloud Controller Manager](https://kubernetes.io/docs/tasks/administer-cluster/developing-cloud-controller-manager/) | ||
|
||
## Requirements | ||
* Kubernetes 1.13+ | ||
* `kube-apiserver` and `kube-controller-manager` MUST NOT specify the `--cloud-provider` flag. This ensures that it does not run any cloud specific loops that would be run by cloud controller manager. In the future, this flag will be deprecated and removed. | ||
* `kubelet` must run with `--cloud-provider=external`. This is to ensure that the kubelet is aware that it must be initialized by the cloud controller manager before it is scheduled any work. | ||
* `kube-apiserver` SHOULD NOT run the `PersistentVolumeLabel` admission controller since the cloud controller manager takes over labeling persistent volumes. | ||
|
||
## IAM Policy | ||
For the aws-cloud-controller-manager to be able to communicate to AWS APIs, you will need to create a few IAM policies for your EC2 instances. The master policy is a bit open and can be scaled back depending on the use case. Adjust these based on your needs. | ||
|
||
1. [Master Policy](https://github.com/kubernetes/cloud-provider-aws/blob/master/deploy/master_iam_policy.json) | ||
2. [Node Policy](https://github.com/kubernetes/cloud-provider-aws/blob/master/deploy/node_iam_policy.json) | ||
|
||
## Proper Node Names | ||
The cloud provider currently uses the instance private DNS name as the node name, but this is subject to change in the future. | ||
|
||
## Development | ||
This code builds with Golang 1.11+. The `make` command will build and test the project. This project uses [go dep](https://golang.github.io/dep/) for dependency management but will use native Go modules in the near future. | ||
|
||
## License | ||
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. | ||
|
||
## NOTE | ||
This is not an officially supported Amazon product. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mcrute why did you close this?
could you at least put this file in so it doesn't mislead people that this is currently usable?