cloud-gov / compliance

Compliance automation for cloud.gov
Other
36 stars 22 forks source link

"Starting ATO Documentation for cloud.gov applications" instructions don't work #183

Closed jtconnor closed 8 years ago

jtconnor commented 8 years ago

I tried to follow the instructions for "Starting ATO Documentation for cloud.gov applications" and am getting an error.

Here's my opencontrol.yaml file:

schema_version: "1.0.0"
name: Geography API
metadata:
  description: "Shared services for Geographic data"
  maintainers:
    - james@superbrilliant.io
components: # A list of paths to components written in the opencontrol format for more information view: https://github.com/opencontrol/schemas
  - ./component
dependencies:
  systems:
    - url: github.com/18F/cg-compliance
      revision: master

and my component.yaml (at ./component/component.yaml):

name: Geography API
documentation_complete: false
schema_version: 3.0.0

satisfies:
  - standard_key: NIST-800-53
    control_key: CM-2
    narrative:
      - key: The optional key that represents a particular section of the control. If the key is not specified, assume the string in the following text represents the entire control
        text: The narrative text for the particular section / entire control if there is no key specified
    parameters:
     - key: "The key for a particular parameter of the specific control"
       text: "The parameter text for a particular parameter of a specific control"
    covered_by:
      - verification_key: The specific verification ID that the reference links, no component or system is needed for internal references
      - system_key: System name of the verification (can link to other systems / components)
        component_key: System name of the verification (can link to other systems / components)
        verification_key: The specific verification ID that the reference links to

that I verified using kwalify:

$ kwalify -f $HOME/git/opencontrol/schemas/kwalify/component/v3.0.0.yaml ./component/component.yaml 
./component/component.yaml#0: valid.

When I run compliance-masonry I get an error:

$ compliance-masonry get
[Error: Repo initialization failed Repo: github.com/18F/cg-compliance Revision: master Dir: /var/folders/__/178mh77578v3pkv2l7cqpchh0000gn/T/opencontrol-resources433143863/components/cg-compliance Error Details: Cannot detect VCS]

I'm not sure whether the issue is with cg-compliance, the setup instructions, my attempt to follow the setup instrutions, or with compliance-masonry. How do you think I should proceed to get started using opencontrol for ATO documentation?

afeld commented 8 years ago

Try changing

url: github.com/18F/cg-compliance
# to
url: https://github.com/18F/cg-compliance
jtconnor commented 8 years ago

Yep, that's it, thanks @afeld ! I sent you a #184 to fix the typo in the README