Skip to content
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.

Sign up for GitHub

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

CDPCAM-43: Added more links to the Issue Templates #24

Merged
merged 1 commit into from
Aug 23, 2021
Merged

CDPCAM-43: Added more links to the Issue Templates #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 31 additions & 1 deletion cdpctl/validation/infra/issue_templates.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,86 +13,110 @@ docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-creat
---
id: AWS_IDBROKER_INSTANCE_PROLFILE_NEEDS_ROLE
summary: "IDBroker instance profile {0} should contain an IDBroker role."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-idbroker-minimum-setup.html#autoId1
---
id: AWS_IDBROKER_ROLE_NEED_EC2_TRUST_POLICY
summary: "The IDBroker role {0} should contain a trust policy for EC2"
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-idbroker-minimum-setup.html#autoId1
---
id: AWS_ROLE_FOR_DL_BUCKET_MISSING_ACTIONS
summary: "The role ({0}) requires the following actions for the Datalake S3 bucket ({1})."
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-policy-definitions.html#autoId4
---
id: AWS_ROLE_REQUIRES_ACTIONS_FOR_ALL_S3_RESOURCES
summary: "The role ({0}) requires the following actions for all S3 resources"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-policy-definitions.html
---
id: AWS_ROLE_FOR_DATA_BUCKET_MISSING_ACTIONS
summary: "The role ({0}) requires the following actions for the S3 data location ({1})."
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-policy-definitions.html#autoId4
---
id: AWS_IDBROKER_ROLE_REQUIRES_ACTIONS_FOR_ALL_RESOURCES
summary: "The role ({0}) requires the following actions for resource wildcard (*)."
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-policy-definitions.html#autoId0
---
id: AWS_ROLE_REQUIRES_ACTIONS_FOR_ALL_EC2_RESOURCES
summary: "The role ({0}) requires the following actions for all EC2 resources ([*])"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-permissions.html
---
id: AWS_ROLE_REQUIRES_ACTIONS_FOR_ALL_RESOURCES
summary: "The role ({0}) requires the following actions for all resources ([*])"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-permissions.html
---
id: AWS_ROLE_REQUIRES_ACTIONS_FOR_SERVICE_ROLL_RESOURCES
summary: "The role ({0}) requires the following actions for all resources (\"arn:aws:iam::*:role/aws-service-role/*\")"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-permissions.html
---
id: AWS_ROLE_REQUIRES_ACTIONS_FOR_LOG_PATH
summary: "The role ({0}) requires the following actions for the log storage path ({1}):"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-policy-definitions.html#autoId1
---
id: AWS_ROLE_REQUIRES_ACTIONS_FOR_LOG_BUCKET
summary: "The role ({0}) requires the following actions for the log storage bucket ({1}):"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-policy-definitions.html#autoId1
---
id: AWS_LOGGER_INSTANCE_PROFILE_SHOULD_CONTAIN_LOGGER_ROLE
summary: "The logger instance profile {0} set in config {1} should contain a logger role."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-idbroker-minimum-setup.html#autoId1
---
id: AWS_LOGGER_ROLE_SHOULD_HAVE_EC2_TRUST
summary: "The logger role {0} should contain a trust policy for EC2"
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-idbroker-minimum-setup.html#autoId1
---
id: AWS_S3_BUCKET_INVALID
summary: "The s3a url {0} is invalid."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-s3.html
---
id: AWS_S3_BUCKET_DOES_NOT_EXIST
summary: "S3 bucket {0} does not exist."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-s3.html
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also go without a link for this one as it's self-explanatory. Probably also for forbidden access below. I'm fine either way.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah thought it it a bit but at least it gives them a link to say ... "oh yeah its it is in the docs"

---
id: AWS_S3_BUCKET_FORBIDDEN_ACCESS
summary: "S3 bucket {0} has forbidden access."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-iam-policy-definitions.html
---
id: AWS_NON_CCM_DEFAULT_SG_NEEDS_TO_ALLOW_CDP_CIDRS
summary: "The default security group {0} is missing TCP port 9443 for the following Cloudera CDP CIDRs when not using CCM (env:tunnel = false)."
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-security-groups.html
---
id: AWS_NON_CCM_GATEWAY_SG_MISSING_CIDRS
summary: "When not using CCM (tunnel = false), the gateway security group {0} is missing the following access:"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-security-groups.html
---
id: AWS_DEFAULT_SG_NEEDS_ALLOW_ACCESS_INTERNAL_TO_VPC
summary: "Your Default Security Group {0} should allow access to all TCP and UDP ports (0-65535) internal to the VPC"
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-security-groups.html
---
id: AWS_GATEWAY_SG_NEEDS_ALLOW_ACCESS_INTERNAL_TO_VPC
summary: "Your Gateway Security Group {0} should allow access to all TCP and UDP ports (0-65535) internal to the VPC"
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-security-groups.html
---
id: AWS_SSH_KEY_ID_DOES_NOT_EXIST
summary: "SSH key id ({0}) does not exist."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-ssh.html
---
id: AWS_SSH_IS_INVALID
summary: "SSH Key ID ({0}) is not valid."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-ssh.html
---
id: AWS_NOT_ENOUGH_SUBNETS_PROVIDED
summary: "Not enough {0} Subnets provided, at least 3 subnets required."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
---
id: AWS_INVALID_SUBNET_ID
summary: The {0} Subnet ID {1} is invalid.
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
---
id: AWS_REQUIRED_DATA_MISSING
summary: "Missing required data: {0}"
Expand All @@ -103,9 +127,11 @@ summary: "Validation Error - invalid data : {0}"
id: AWS_SUBNETS_DO_NOT_EXIST
summary: "The following {0} Subnets do not exist."
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
---
id: AWS_NOT_ENOUGH_AZ_FOR_SUBNETS
summary: "Not enough availability zones, {0} subnets should spread across at least 2 availability zones."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
---
id: AWS_SUBNETS_WITHOUT_INTERNET_GATEWAY
summary: "These {0} Subnets do not have an internet gateway(s)"
Expand All @@ -123,15 +149,19 @@ docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-r
render_type: list
---
id: AWS_SUBNETS_MISSING_K8S_LB_TAG
summary: "These {0} Subnets do not have the nessesary 'kubernetes.io/role/elb' tag."
summary: "These {0} Subnets do not have the nessesary 'kubernetes.io/role/elb' tags to run the Data Engineering, DataFlow, Data Warehouse, or Machine Learning experiences."
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
---
id: AWS_SUBNETS_NOT_PART_OF_VPC
summary: "The following subnets are not associated with the provided VPC {0}:"
render_type: list
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
---
id: AWS_DNS_SUPPORT_NOT_ENABLED_FOR_VPC
summary: "DNS support is not enabled for VPC id {0}"
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
---
id: AWS_VPC_NOT_FOUND_IN_ACCOUNT
summary: "VPC ID {0} set in infra:aws:vpc:existing:vpc_id was not found in the AWS account."
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-vpc.html
3 changes: 3 additions & 0 deletions cdpctl/validation/issue_templates.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,15 @@ summary: No profile was defined for for config option {0}
---
id: AWS_REGION_CONFIG_NOT_DEFINED
summary: No region config option defined {0}
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-region.html
---
id: AWS_REGION_NOT_DEFINED
summary: No region was defined for for config option {0}
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-aws-req-region.html
---
id: AWS_MISSING_ACTIONS
summary: "The following IAM actions are required:"
---
id: AWS_INSTANCE_PROFILE_NOT_FOUND
summary: The IAM Instance Profile {0} was not found
docs_link: https://docs.cloudera.com/cdp/latest/requirements-aws/topics/mc-idbroker-minimum-setup.html