mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-25 06:10:31 -07:00
Documentation Refactor
This commit is contained in:
The Magician
Alex Stephen
parent
6a98471a53
commit
87656c4016
88 changed files with 11960 additions and 12598 deletions
|
|
@ -52,10 +52,10 @@ options:
|
|||
description:
|
||||
- A reference to BackendService resource if none of the hostRules match.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can be
|
||||
specified in two ways. First, you can place a dictionary with key ''selfLink''
|
||||
and value of your resource''s selfLink Alternatively, you can add `register:
|
||||
name-of-resource` to a gcp_compute_backend_service task and then set this default_service
|
||||
field to "{{ name-of-resource }}"'
|
||||
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
|
||||
task and then set this default_service field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this default_service to a dictionary with the selfLink key where
|
||||
the value is the selfLink of your BackendService'
|
||||
required: true
|
||||
description:
|
||||
description:
|
||||
|
|
@ -74,12 +74,14 @@ options:
|
|||
required: false
|
||||
hosts:
|
||||
description:
|
||||
- A reference to BackendService resource if none of the hostRules match.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
|
||||
task and then set this default_service field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this default_service to a dictionary with the selfLink key where the
|
||||
value is the selfLink of your BackendService.'
|
||||
- The list of host patterns to match. They must be valid hostnames, except
|
||||
* will match any string of ([a-z0-9-.]*). In that case, * must be the first
|
||||
character and must be followed in the pattern by either - or .
|
||||
required: true
|
||||
path_matcher:
|
||||
description:
|
||||
- The name of the PathMatcher to use to match the path portion of the URL
|
||||
if the hostRule matches the URL's host portion.
|
||||
required: true
|
||||
name:
|
||||
description:
|
||||
|
|
@ -100,111 +102,70 @@ options:
|
|||
- A reference to a BackendService resource. This will be used if none of the
|
||||
pathRules defined by this PathMatcher is matched by the URL's path portion.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can
|
||||
be specified in two ways. First, you can place a dictionary with key ''selfLink''
|
||||
and value of your resource''s selfLink Alternatively, you can add `register:
|
||||
name-of-resource` to a gcp_compute_backend_service task and then set this
|
||||
default_service field to "{{ name-of-resource }}"'
|
||||
be specified in two ways. You can add `register: name-of-resource` to a
|
||||
gcp_compute_backend_service task and then set this default_service field
|
||||
to "{{ name-of-resource }}" Alternatively, you can set this default_service
|
||||
to a dictionary with the selfLink key where the value is the selfLink of
|
||||
your BackendService'
|
||||
required: true
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
suboptions:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this HostRule. Provide this property when you create
|
||||
the resource.
|
||||
required: false
|
||||
hosts:
|
||||
description:
|
||||
- The list of host patterns to match. They must be valid hostnames, except * will
|
||||
match any string of ([a-z0-9-.]*). In that case, * must be the first character and
|
||||
must be followed in the pattern by either - or .
|
||||
required: true
|
||||
path_matcher:
|
||||
description:
|
||||
- The name of the PathMatcher to use to match the path portion of the URL if the hostRule
|
||||
matches the URL's host portion.
|
||||
required: true
|
||||
name:
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. The name
|
||||
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
|
||||
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following characters
|
||||
must be a dash, lowercase letter, or digit, except the last character, which cannot
|
||||
be a dash.
|
||||
- The name to which this PathMatcher is referred by the HostRule.
|
||||
required: true
|
||||
path_matchers:
|
||||
path_rules:
|
||||
description:
|
||||
- The list of path rules.
|
||||
required: false
|
||||
suboptions:
|
||||
default_service:
|
||||
description:
|
||||
- A reference to a BackendService resource. This will be used if none of the pathRules
|
||||
defined by this PathMatcher is matched by the URL's path portion.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
|
||||
task and then set this default_service field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this default_service to a dictionary with the selfLink key where the
|
||||
value is the selfLink of your BackendService.'
|
||||
required: true
|
||||
paths:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
name:
|
||||
description:
|
||||
- The name to which this PathMatcher is referred by the HostRule.
|
||||
required: true
|
||||
path_rules:
|
||||
description:
|
||||
- The list of path rules.
|
||||
required: false
|
||||
suboptions:
|
||||
paths:
|
||||
description:
|
||||
- 'The list of path patterns to match. Each must start with / and the only place a
|
||||
* is allowed is at the end following a /. The string fed to the path matcher does
|
||||
not include any text after the first ? or #, and those chars are not allowed here.'
|
||||
required: true
|
||||
service:
|
||||
description:
|
||||
- A reference to the BackendService resource if this rule is matched.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
|
||||
task and then set this service field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this service to a dictionary with the selfLink key where the value is
|
||||
the selfLink of your BackendService.'
|
||||
required: true
|
||||
tests:
|
||||
- 'The list of path patterns to match. Each must start with / and the
|
||||
only place a * is allowed is at the end following a /. The string fed
|
||||
to the path matcher does not include any text after the first ? or #,
|
||||
and those chars are not allowed here.'
|
||||
required: true
|
||||
service:
|
||||
description:
|
||||
- A reference to the BackendService resource if this rule is matched.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It
|
||||
can be specified in two ways. You can add `register: name-of-resource`
|
||||
to a gcp_compute_backend_service task and then set this service field
|
||||
to "{{ name-of-resource }}" Alternatively, you can set this service
|
||||
to a dictionary with the selfLink key where the value is the selfLink
|
||||
of your BackendService'
|
||||
required: true
|
||||
tests:
|
||||
description:
|
||||
- The list of expected URL mappings. Requests to update this UrlMap will succeed
|
||||
only if all of the test cases pass.
|
||||
required: false
|
||||
suboptions:
|
||||
description:
|
||||
description:
|
||||
- The list of expected URL mappings. Requests to update this UrlMap will succeed only
|
||||
if all of the test cases pass.
|
||||
- Description of this test case.
|
||||
required: false
|
||||
suboptions:
|
||||
description:
|
||||
description:
|
||||
- Description of this test case.
|
||||
required: false
|
||||
host:
|
||||
description:
|
||||
- Host portion of the URL.
|
||||
required: true
|
||||
path:
|
||||
description:
|
||||
- Path portion of the URL.
|
||||
required: true
|
||||
service:
|
||||
description:
|
||||
- A reference to expected BackendService resource the given URL should be mapped to.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
|
||||
task and then set this service field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this service to a dictionary with the selfLink key where the value is
|
||||
the selfLink of your BackendService.'
|
||||
required: true
|
||||
host:
|
||||
description:
|
||||
- Host portion of the URL.
|
||||
required: true
|
||||
path:
|
||||
description:
|
||||
- Path portion of the URL.
|
||||
required: true
|
||||
service:
|
||||
description:
|
||||
- A reference to expected BackendService resource the given URL should be
|
||||
mapped to.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can
|
||||
be specified in two ways. You can add `register: name-of-resource` to a
|
||||
gcp_compute_backend_service task and then set this service field to "{{
|
||||
name-of-resource }}" Alternatively, you can set this service to a dictionary
|
||||
with the selfLink key where the value is the selfLink of your BackendService'
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
'''
|
||||
|
||||
|
|
@ -257,135 +218,137 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
defaultService:
|
||||
description:
|
||||
- A reference to BackendService resource if none of the hostRules match.
|
||||
returned: success
|
||||
type: dict
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
defaultService:
|
||||
description:
|
||||
- A reference to BackendService resource if none of the hostRules match.
|
||||
returned: success
|
||||
type: dict
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
hostRules:
|
||||
description:
|
||||
- The list of HostRules to use against the URL.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
hostRules:
|
||||
description:
|
||||
- The list of HostRules to use against the URL.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this HostRule. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
hosts:
|
||||
description:
|
||||
- The list of host patterns to match. They must be valid hostnames, except * will
|
||||
match any string of ([a-z0-9-.]*). In that case, * must be the first character and
|
||||
must be followed in the pattern by either - or .
|
||||
returned: success
|
||||
type: list
|
||||
pathMatcher:
|
||||
description:
|
||||
- The name of the PathMatcher to use to match the path portion of the URL if the hostRule
|
||||
matches the URL's host portion.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource.
|
||||
returned: success
|
||||
type: int
|
||||
fingerprint:
|
||||
description:
|
||||
- Fingerprint of this resource. This field is used internally during updates of this
|
||||
resource.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
- An optional description of this HostRule. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
hosts:
|
||||
description:
|
||||
- The list of host patterns to match. They must be valid hostnames, except *
|
||||
will match any string of ([a-z0-9-.]*). In that case, * must be the first
|
||||
character and must be followed in the pattern by either - or .
|
||||
returned: success
|
||||
type: list
|
||||
pathMatcher:
|
||||
description:
|
||||
- The name of the PathMatcher to use to match the path portion of the URL if
|
||||
the hostRule matches the URL's host portion.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource.
|
||||
returned: success
|
||||
type: int
|
||||
fingerprint:
|
||||
description:
|
||||
- Fingerprint of this resource. This field is used internally during updates of
|
||||
this resource.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. The
|
||||
name must be 1-63 characters long, and comply with RFC1035. Specifically, the
|
||||
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following
|
||||
characters must be a dash, lowercase letter, or digit, except the last character,
|
||||
which cannot be a dash.
|
||||
returned: success
|
||||
type: str
|
||||
pathMatchers:
|
||||
description:
|
||||
- The list of named PathMatchers to use against the URL.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
defaultService:
|
||||
description:
|
||||
- A reference to a BackendService resource. This will be used if none of the
|
||||
pathRules defined by this PathMatcher is matched by the URL's path portion.
|
||||
returned: success
|
||||
type: dict
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. The name
|
||||
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
|
||||
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following characters
|
||||
must be a dash, lowercase letter, or digit, except the last character, which cannot
|
||||
be a dash.
|
||||
returned: success
|
||||
type: str
|
||||
pathMatchers:
|
||||
description:
|
||||
- The list of named PathMatchers to use against the URL.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
defaultService:
|
||||
description:
|
||||
- A reference to a BackendService resource. This will be used if none of the pathRules
|
||||
defined by this PathMatcher is matched by the URL's path portion.
|
||||
returned: success
|
||||
type: dict
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name to which this PathMatcher is referred by the HostRule.
|
||||
returned: success
|
||||
type: str
|
||||
pathRules:
|
||||
description:
|
||||
- The list of path rules.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
paths:
|
||||
description:
|
||||
- 'The list of path patterns to match. Each must start with / and the only place a
|
||||
* is allowed is at the end following a /. The string fed to the path matcher does
|
||||
not include any text after the first ? or #, and those chars are not allowed here.'
|
||||
returned: success
|
||||
type: list
|
||||
service:
|
||||
description:
|
||||
- A reference to the BackendService resource if this rule is matched.
|
||||
returned: success
|
||||
type: dict
|
||||
tests:
|
||||
description:
|
||||
- The list of expected URL mappings. Requests to update this UrlMap will succeed only
|
||||
if all of the test cases pass.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
description:
|
||||
description:
|
||||
- Description of this test case.
|
||||
returned: success
|
||||
type: str
|
||||
host:
|
||||
description:
|
||||
- Host portion of the URL.
|
||||
returned: success
|
||||
type: str
|
||||
path:
|
||||
description:
|
||||
- Path portion of the URL.
|
||||
returned: success
|
||||
type: str
|
||||
service:
|
||||
description:
|
||||
- A reference to expected BackendService resource the given URL should be mapped to.
|
||||
returned: success
|
||||
type: dict
|
||||
description:
|
||||
- The name to which this PathMatcher is referred by the HostRule.
|
||||
returned: success
|
||||
type: str
|
||||
pathRules:
|
||||
description:
|
||||
- The list of path rules.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
paths:
|
||||
description:
|
||||
- 'The list of path patterns to match. Each must start with / and the only
|
||||
place a * is allowed is at the end following a /. The string fed to the
|
||||
path matcher does not include any text after the first ? or #, and those
|
||||
chars are not allowed here.'
|
||||
returned: success
|
||||
type: list
|
||||
service:
|
||||
description:
|
||||
- A reference to the BackendService resource if this rule is matched.
|
||||
returned: success
|
||||
type: dict
|
||||
tests:
|
||||
description:
|
||||
- The list of expected URL mappings. Requests to update this UrlMap will succeed
|
||||
only if all of the test cases pass.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
description:
|
||||
description:
|
||||
- Description of this test case.
|
||||
returned: success
|
||||
type: str
|
||||
host:
|
||||
description:
|
||||
- Host portion of the URL.
|
||||
returned: success
|
||||
type: str
|
||||
path:
|
||||
description:
|
||||
- Path portion of the URL.
|
||||
returned: success
|
||||
type: str
|
||||
service:
|
||||
description:
|
||||
- A reference to expected BackendService resource the given URL should be mapped
|
||||
to.
|
||||
returned: success
|
||||
type: dict
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue