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.

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

Inconsistencies between official documentation and Resource Specification #53

Closed
afronski opened this issue Nov 26, 2017 · 0 comments
Closed

Comments

@afronski
Copy link
Contributor

afronski commented Nov 26, 2017

Sigh.

We cannot trust entirely Resource Specification from AWS API, because we've already found inconsistencies:

Inconsistent URLs between specification and reality

a) Real URL to docs:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributionconfig.html#cfn-cloudfront-distributionconfig-defaultcachebehavior

b) URL from specifications:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior

The one from specifications does not exists 😕 Small difference between those two, but still.

Specs are not up to date in every case

    "AWS::CloudFront::Distribution.DistributionConfig": {
      "Properties": {
        ...
        "DefaultCacheBehavior": {
          "Type": "DefaultCacheBehavior",
          "Required": false,
          "Documentation": "https://...",
          "UpdateType": "Mutable"
        },
      ...
      }
    }

Look at the required property value - false.
And now take a look at the documentation:

DefaultCacheBehavior
The default cache behavior that is triggered if you 
do not specify the CacheBehavior property or if files 
don't match any of the values of PathPattern in 
the CacheBehavior property.

Required: Yes

Type: DefaultCacheBehavior type

When the first one issue is not so big, the second one may cause us some problems, I hope there are not too many inconsistencies like that.

Solution:

We need to create a patching mechanism inside perun that will allow patch in place via code / configuration those exceptions.

@afronski afronski added this to the Cumulus - 2.0 milestone Nov 26, 2017
@afronski afronski changed the title Inconsistencies between official documentation and Resource specification Inconsistencies between official documentation and Resource Specification Nov 26, 2017
@rusty-2 rusty-2 self-assigned this Apr 5, 2018
@pfigwer pfigwer assigned piwowarc and unassigned rusty-2 Jun 28, 2018
pfigwer pushed a commit that referenced this issue Jun 29, 2018
Inconsistencies between official documentation and Resource Specification #53
@piwowarc piwowarc closed this as completed Jul 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants