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

Added more explanation to keypair. #52766

Open
wants to merge 3 commits into
base: devel
from

Conversation

Projects
None yet
4 participants
@AHassanSOS
Copy link

AHassanSOS commented Feb 21, 2019

+label: docsite_pr

SUMMARY

Added more explanation to key_pair.

Added more explanation to keypair.
<!--- Your description here -->

+label: docsite_pr
@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Feb 21, 2019

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:32:161: E501 line too long (177 > 160 characters)

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Feb 21, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Feb 21, 2019

@AHassanSOS, just so you are aware we have a dedicated Working Group for aws.
You can find other people interested in this in #ansible-aws on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

ansibot commented Feb 21, 2019

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.8 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
cat _themes/srtd/static/css/theme.css | sed -e 's/^[ 	]*//g; s/[ 	]*$//g; s/\([:{;,]\) /\1/g; s/ {/{/g; s/\/\*.*\*\///g; /^$/d' | sed -e :a -e '$!N; s/\n\(.\)/\1/; ta' > _themes/srtd/static/css/theme.min.css
PYTHONPATH=../../lib ../bin/dump_config.py --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ -d ../../lib/ansible/config/base.yml
mkdir -p rst/cli
PYTHONPATH=../../lib ../bin/generate_man.py --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst ../../lib/ansible/cli/*.py
PYTHONPATH=../../lib ../bin/dump_keywords.py --template-dir=../templates --output-dir=rst/reference_appendices/ -d ./keyword_desc.yml
PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/modules/ 
Evaluating module files...
Makefile:93: recipe for target 'modules' failed
--> Standard Error
Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 774, in <module>
    main()
  File "../bin/plugin_formatter.py", line 729, in main
    plugin_info, categories = get_plugin_info(options.module_dir, limit_to=options.limit_to, verbose=(options.verbosity > 0))
  File "../bin/plugin_formatter.py", line 294, in get_plugin_info
    doc, examples, returndocs, metadata = plugin_docs.get_docstring(module_path, fragment_loader, verbose=verbose)
  File "/root/ansible/lib/ansible/utils/plugin_docs.py", line 103, in get_docstring
    data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
  File "/root/ansible/lib/ansible/parsing/plugin_docs.py", line 59, in read_docstring
    data[varkey] = AnsibleLoader(child.value.s, file_name=filename).get_single_data()
  File "/usr/local/lib/python3.6/dist-packages/yaml/constructor.py", line 35, in get_single_data
    node = self.get_single_node()
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 36, in get_single_node
    document = self.compose_document()
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 55, in compose_document
    node = self.compose_node(None, None)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 84, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 133, in compose_mapping_node
    item_value = self.compose_node(node, item_key)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 84, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 133, in compose_mapping_node
    item_value = self.compose_node(node, item_key)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 84, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 133, in compose_mapping_node
    item_value = self.compose_node(node, item_key)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 82, in compose_node
    node = self.compose_sequence_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 110, in compose_sequence_node
    while not self.check_event(SequenceEndEvent):
  File "/usr/local/lib/python3.6/dist-packages/yaml/parser.py", line 98, in check_event
    self.current_event = self.state()
  File "/usr/local/lib/python3.6/dist-packages/yaml/parser.py", line 382, in parse_block_sequence_entry
    if self.check_token(BlockEntryToken):
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 115, in check_token
    while self.need_more_tokens():
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 149, in need_more_tokens
    self.stale_possible_simple_keys()
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 289, in stale_possible_simple_keys
    "could not find expected ':'", self.get_mark())
yaml.scanner.ScannerError: while scanning a simple key
  in "<unicode string>", line 12, column 7:
          take a look at `ec2_key` module.
          ^
could not find expected ':'
  in "<unicode string>", line 13, column 5:
        aliases: ['keypair']
        ^
make: *** [modules] Error 1

The test ansible-test sanity --test validate-modules [explain] failed with 14 errors:

lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'count' in argument_spec defines default as (1) but documentation defines default as (None)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'instance_initiated_shutdown_behavior' in argument_spec defines default as ('stop') but documentation defines default as (None)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'spot_type' in argument_spec defines default as ('one-time') but documentation defines default as (None)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'spot_wait_timeout' in argument_spec defines default as ('600') but documentation defines default as (None)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'tenancy' in argument_spec defines default as ('default') but documentation defines default as (None)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'validate_certs' in argument_spec defines default as (True) but documentation defines default as (False)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E324 Argument 'wait_timeout' in argument_spec defines default as ('300') but documentation defines default as (None)
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E326 Argument 'instance_initiated_shutdown_behavior' in argument_spec defines choices as (['stop', 'terminate']) but documentation defines choices as ([])
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E326 Argument 'spot_type' in argument_spec defines choices as (['one-time', 'persistent']) but documentation defines choices as ([])
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E326 Argument 'state' in argument_spec defines choices as (['present', 'absent', 'running', 'restarted', 'stopped']) but documentation defines choices as ([])
lib/ansible/modules/cloud/amazon/ec2.py:0:0: E326 Argument 'tenancy' in argument_spec defines choices as (['default', 'dedicated']) but documentation defines choices as ([])
lib/ansible/modules/cloud/amazon/ec2.py:34:5: E302 DOCUMENTATION is not valid YAML
test/sanity/validate-modules/ignore.txt:22:1: A102 Remove since "lib/ansible/modules/cloud/amazon/ec2.py" passes "E322" test

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2.py:34:5: error DOCUMENTATION: syntax error: could not find expected ':'

click here for bot help

@AHassanSOS

This comment has been minimized.

Copy link
Author

AHassanSOS commented Feb 22, 2019

@mattclay Could you help me? I don't know why the CI is failing.

@mattclay

This comment has been minimized.

Copy link
Member

mattclay commented Feb 22, 2019

@AHassanSOS Your whitespace change has fixed the CI failure.

@AHassanSOS

This comment has been minimized.

Copy link
Author

AHassanSOS commented Feb 22, 2019

Awesome! Do I need to do anything else in order to merge it?

@ansibot ansibot added core_review and removed needs_revision labels Feb 22, 2019

@AHassanSOS

This comment has been minimized.

Copy link
Author

AHassanSOS commented Feb 25, 2019

Ping! Do I need to do anything else?

@ansibot ansibot added the stale_ci label Mar 5, 2019

@AHassanSOS

This comment has been minimized.

Copy link
Author

AHassanSOS commented Mar 5, 2019

Ping!

@AHassanSOS AHassanSOS closed this Mar 5, 2019

@AHassanSOS AHassanSOS reopened this Mar 5, 2019

@ansibot ansibot removed the stale_ci label Mar 5, 2019

@AHassanSOS

This comment has been minimized.

Copy link
Author

AHassanSOS commented Mar 13, 2019

yawn

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.