From cb6f6b00445034a6af65bd8ff7126d1e16573c25 Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Tue, 19 Oct 2021 10:20:49 +0000 Subject: [PATCH 01/11] Change the way we generate the doc -> retrieve terraform doc generation scripts -> add submodule doc-terraform-template repo (v5.0) -> add submodule of osc-api --- .gitignore | 6 +- .gitmodules | 6 + docs/doc-terraform-template | 1 + docs/generate_doc_terraform.py | 597 +++++++++++++++++++++++++++++++++ docs/osc-api | 1 + docs/requirements.txt | 3 + scripts/generate-doc.sh | 26 ++ 7 files changed, 639 insertions(+), 1 deletion(-) create mode 100644 .gitmodules create mode 160000 docs/doc-terraform-template create mode 100644 docs/generate_doc_terraform.py create mode 160000 docs/osc-api create mode 100644 docs/requirements.txt create mode 100755 scripts/generate-doc.sh diff --git a/.gitignore b/.gitignore index db7d03df2..9e25a1cb1 100644 --- a/.gitignore +++ b/.gitignore @@ -32,4 +32,8 @@ terraformStatePull.json /tests/resources.auto.tfvars.template.cpgz /tests/test.tf /tests/old.py -/tests/tmp.txt \ No newline at end of file +/tests/tmp.txt + +# docs +docs/generation_log.txt +docs/.venv \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..69ffbbf53 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,6 @@ +[submodule "docs/osc-api"] + path = docs/osc-api + url = https://github.com/outscale/osc-api +[submodule "docs/doc-terraform-template"] + path = docs/doc-terraform-template + url = https://gitlab.outscale.internal/rd/doc-terraform-template.git diff --git a/docs/doc-terraform-template b/docs/doc-terraform-template new file mode 160000 index 000000000..0d6765412 --- /dev/null +++ b/docs/doc-terraform-template @@ -0,0 +1 @@ +Subproject commit 0d6765412fd5519c8dbf5d2483b0f836e562c6ec diff --git a/docs/generate_doc_terraform.py b/docs/generate_doc_terraform.py new file mode 100644 index 000000000..47a9aeaa3 --- /dev/null +++ b/docs/generate_doc_terraform.py @@ -0,0 +1,597 @@ +#!/usr/bin/env python3 +# -*- coding:utf-8 -*- + +import argparse +import csv +import io +import re +import shutil +import os +import yaml + +import gtw.api.openapi.parser as openapi_parser +import gtw.api.schema as schema +import gtw.api.utils as utils + +# NOTE : python3 generate_doc_terraform.py --provider_directory /Users/mercatguillaume/workspace/terraform-provider-outscale/outscale --api /Users/mercatguillaume/workspace/osc-api/outscale.yaml --output_directory /Users/mercatguillaume/workspace/output_test --template_directory /Users/mercatguillaume/workspace/api-framework/terraform_template + +parser = argparse.ArgumentParser(description='Generate documentation terraform') +parser.add_argument('--new_format', action='store_true') +parser.add_argument('--no-addapt', action='store_true') +parser.add_argument('--provider_directory', required=True) +parser.add_argument('--template_directory', required=True) +parser.add_argument('--api', help='Source oAPI specification path.', + required=True) +parser.add_argument('--output_directory', help='Output directory path.', + required=True) +ARGS = parser.parse_args() + + +def print_dict(item, path, profondeur): + result = str() + if isinstance(item, schema.ObjectField): + # if path not in code_file: + # print(' - {} not found'.format(path)) + result += ' ' * profondeur + '* `{}` - {}\n'.format(path, + item.description) + profondeur += 1 + for x, y in sorted(item.properties.items()): + next_path = utils.camel_case_to_snake_case(x) + if isinstance(y, schema.TerminalField): + # if next_path not in code_file: + # print(' - {} not found'.format(next_path)) + result += ' ' * profondeur + '* `{}` - {}\n'.format(next_path, y.description) + else: + result += print_dict( + # code_file, + y, next_path, profondeur) + return result + elif isinstance(item, schema.ArrayField): + if isinstance(item.item, schema.ObjectField): + #if path not in code_file: + # print(' - {} not found'.format(path)) + result += ' ' * profondeur + '* `{}` - {}\n'.format(path, item.description) + profondeur += 1 + for x, y in sorted(item.item.properties.items()): + next_path = utils.camel_case_to_snake_case(x) + if isinstance(y, schema.TerminalField): + #if next_path not in code_file: + # print('{} not found'.format(next_path)) + result += ' ' * profondeur + '* `{}` - {}\n'.format(next_path, y.description) + else: + result += '{}'.format(print_dict( + #code_file, + y, next_path, profondeur)) + return result + elif isinstance(item.item, schema.TerminalField): + #if path not in code_file: + # print(' - {} not found'.format(path)) + return ' ' * profondeur + '* `{}` - {}\n'.format(path, item.description) + elif isinstance(item, schema.TerminalField): + #if path not in code_file: + # print(' - {} not found'.format(path)) + return ' ' * profondeur + '* `{}` - {}\n'.format(path, item.description) + else: + return path + '\n' + + +def print_dict_input(item, path, profondeur, mandatories=[]): + result = str() + if isinstance(item, schema.ObjectField): + #if path not in code_file: + # print(' - {} not found'.format(path)) + result += ' ' * profondeur + '* `{}` - {}\n'.format(path, + item.description) + profondeur += 1 + for x, y in sorted(item.properties.items()): + next_path = utils.camel_case_to_snake_case(x) + if isinstance(y, schema.TerminalField): + #if next_path not in code_file: + # print(' - {} not found'.format(next_path)) + result += ' ' * profondeur + '* `{}` - ({}) {}\n'.format(next_path, + 'Required' + if y.name in mandatories + else 'Optional', + y.description) + else: + result_calculed = print_dict_input( + #code_file, + y, + next_path, + profondeur, + mandatories) + result += '{}'.format(result_calculed) + return result + elif isinstance(item, schema.ArrayField): + if isinstance(item.item, schema.ObjectField): + #if path not in code_file: + # print(' - {} not found'.format(path)) + result += ' ' * profondeur + '* `{}` - ({}) {}\n'.format(path, + 'Required' + if item.name in mandatories + else 'Optional', + item.description) + profondeur += 1 + for x, y in sorted(item.item.properties.items()): + next_path = utils.camel_case_to_snake_case(x) + if isinstance(y, schema.TerminalField): + #if next_path not in code_file: + # print(' - {} not found'.format(next_path)) + result += ' ' * profondeur + '* `{}` - ({}) {}\n'.format(next_path, + 'Required' + if y.name in mandatories + else 'Optional', + y.description) + else: + result_calculed = print_dict_input( + #code_file, + y, next_path, + profondeur, mandatories) + result += '{}'.format(result_calculed) + return result + elif isinstance(item.item, schema.TerminalField): + #if path not in code_file: + # print(' - {} not found'.format(path)) + return ' ' * profondeur + '* `{}` - ({}) {}\n'.format(path, + 'Required' + if item.name in mandatories + else 'Optional', + item.description) + elif isinstance(item, schema.TerminalField): + #if path not in code_file: + # print(' - {} not found'.format(path)) + return ' ' * profondeur + '* `{}` - ({}) {}\n'.format(path, + 'Required' + if item.name in mandatories + else 'Optional', + item.description) + else: + return path + '\n' + + +def addField(field_object, key, value): + print('add k: {}, v: {}'.format(key, value)) + if '.' in key: + key_split = key.split('.', 1) + if isinstance(field_object, schema.ObjectField): + if key_split[0] in field_object.properties: + addField(field_object.properties[key_split[0]], key_split[1], value) + else: + if key_split[0] in field_object: + addField(field_object[key_split[0]], key_split[1], value) + else: + new_obj = schema.ObjectField({}, key, 'object', 'in', 'toto', description=value) + if isinstance(field_object, schema.ObjectField): + print('ObjectField') + field_object.properties[key] = new_obj + elif isinstance(field_object, schema.ArrayField): + field_object.item.properties[key] = new_obj + else: + print('dict') + field_object[key] = new_obj + + +def renameField(field_object, key, value): + if '.' in key: + key_split = key.split('.', 1) + renameField(field_object[key_split[0]], key_split[1], value) + else: + if isinstance(field_object, schema.ObjectField): + if key in field_object.properties.keys(): + old = field_object.properties[key] + if isinstance(value, str): + new_key = utils.snake_case_to_camel_case(value) + field_object.properties[new_key] = old + del field_object.properties[key] + else: + new_key = value.get('name', key) + old.description = value.get('description', old.description) + if utils.snake_case_to_camel_case(new_key) != key: + field_object.properties[utils.snake_case_to_camel_case(new_key)] = old + del field_object.properties[key] + else: + print('[WARNING]: you want to rename an unknown field "{}"'.format(key)) + elif isinstance(field_object, schema.ArrayField): + if key in field_object.item.properties.keys(): + old = field_object.item.properties[key] + + if isinstance(value, str): + new_value = utils.snake_case_to_camel_case(value) + field_object.item.properties[new_value] = old + del field_object.item.properties[key] + else: + new_key = value.get('name', key) + old.description = value.get('description', old.description) + if utils.snake_case_to_camel_case(new_key) != key: + field_object.item.properties[utils.snake_case_to_camel_case(new_key)] = old + del field_object.item.properties[key] + else: + print('[WARNING]: you want to rename an unknown field "{}"'.format(key)) + else: + if key in field_object: + old = field_object[key] + + if isinstance(value, str): + new_value = utils.snake_case_to_camel_case(value) + field_object[new_value] = old + del field_object[key] + else: + new_key = value.get('name', key) + old.description = value.get('description', old.description) + if utils.snake_case_to_camel_case(new_key) != key: + field_object[utils.snake_case_to_camel_case(new_key)] = old + del field_object[key] + else: + print('[WARNING]: you want to rename an unknown field "{}"'.format(key)) + + +def removeField(field_object, key): + if '.' in key: + key_split = key.split('.', 1) + removeField(field_object[key_split[0]], key_split[1]) + else: + if isinstance(field_object, schema.ObjectField): + if key in field_object.properties.keys(): + del field_object.properties[key] + else: + print('[WARNING]: you want to delete an unknown field "{}"'.format(key)) + elif isinstance(field_object, schema.ArrayField): + if key in field_object.item.properties.keys(): + del field_object.item.properties[key] + else: + print('[WARNING]: you want to delete an unknown field "{}"'.format(key)) + else: + if key in field_object: + del field_object[key] + else: + print('[WARNING]: you want to delete an unknown field "{}"'.format(key)) + + +def treatAddPropData(field_to_update, part_to_update, addprop_content): + arg = addprop_content.get(part_to_update, None) + if arg and field_to_update: + for k, v in arg.get('add', {}).items(): + new_k = utils.snake_case_to_camel_case(k) + addField(field_to_update, new_k, v) + for k, v in arg.get('rename', {}).items(): + new_k = utils.snake_case_to_camel_case(k) + renameField(field_to_update, new_k, v) + for k in arg.get('remove', []): + new_k = utils.snake_case_to_camel_case(k) + removeField(field_to_update, new_k) + + +def file_template(template, links, resource_name, is_singular, input_field, output_field, example_content, import_content): + resource_name_singular = resource_name if is_singular else resource_name[:-1] + placeholders = links.get(resource_name_singular, 'NOT_FOUND {}'.format(resource_name_singular)) + print('======= placeholders -> {}'.format(placeholders)) + + content_file = template.replace( + 'LINK_UG', + links.get(resource_name_singular, {}).get('LINK_UG', 'NOT_FOUND')) + content_file = content_file.replace( + 'LINK_API', + links.get(resource_name_singular, {}).get('LINK_API', 'NOT_FOUND')) + + content_file = content_file.replace( + 'LITERAL_NAME_PLURAL', + links.get(resource_name_singular, {}).get('LITERAL_NAME_PLURAL', 'NOT_FOUND')) + + if 's' == resource_name[-1:]: + content_file = content_file.replace( + 'ARTICLE ', '') + content_file = content_file.replace( + 'LITERAL_NAME', + links.get(resource_name_singular, {}).get('LITERAL_NAME_PLURAL', 'NOT_FOUND')) + else: + content_file = content_file.replace( + 'ARTICLE', links.get(resource_name_singular, {}).get('ARTICLE', 'NOT_FOUND')) + content_file = content_file.replace( + 'LITERAL_NAME', + links.get(resource_name_singular, {}).get('LITERAL_NAME', 'NOT_FOUND')) + + content_file = content_file.replace('RESOURCE_NAME', resource_name) + content_file = content_file.replace('RESOURCE-NAME', + resource_name.replace('_', '-')) + + content_file = content_file.replace('ARGUMENTS_SENTENCE', 'The following arguments are supported:' if input_field else 'No argument is supported.') + content_file = content_file.replace('INPUT' if input_field else 'INPUT\n', input_field) + + content_file = content_file.replace('ATTRIBUTES_SENTENCE', 'The following attributes are exported:' if output_field else 'No attribute is exported.') + content_file = content_file.replace('OUTPUT' if output_field else 'OUTPUT\n', output_field) + + full_example_content = example_content if len(example_content) else '' + content_file = content_file.replace('EXAMPLE' if full_example_content else 'EXAMPLE\n', full_example_content) + content_file = content_file.replace('IMPORT', import_content) + + content_file = content_file.replace('](#', '](https://docs.outscale.com/api#') + + return content_file + + +def main(): + provider_filename = '{}/provider.go'.format(ARGS.provider_directory) + with io.open(provider_filename, 'r') as f: + provider_file = f.read() + + with io.open('{}/template_ressource.md'.format(ARGS.template_directory), + 'r') as f: + template_resource = f.read() + + with io.open('{}/template_datasource.md'.format(ARGS.template_directory), + 'r') as f: + template_datasource = f.read() + + with io.open('{}/template_datasources.md'.format(ARGS.template_directory), + 'r') as f: + template_datasources = f.read() + + resources = {} + with io.open('{}/resources.csv'.format(ARGS.template_directory), 'r', + newline='', encoding='utf-8') as csv_file: + values = csv.reader(csv_file, delimiter=',') + if not values: + print('No data found.') + else: + for row in values: + resources[row[0]] = [x[1:] for x in row[1:]] + + links = {} + with io.open('{}/links.csv'.format(ARGS.template_directory), 'r', + newline='', encoding='utf-8') as csv_file: + values = csv.reader(csv_file, delimiter=',') + + if not values: + print('No data found.') + else: + for row in values: + links[row[0]] = { + 'ARTICLE': row[1], + 'LITERAL_NAME': row[2], + 'LITERAL_NAME_PLURAL': row[3], + 'LINK_UG': row[4], + 'LINK_API': row[5], + } + + extention = '.md' if ARGS.new_format else '.html.markdown' + index_dirpath = ARGS.output_directory + ('/docs' + if ARGS.new_format else '/website/docs') + navbar_dirpath = ARGS.output_directory + ('/docs' + if ARGS.new_format else '/website') + navbar_file = """<% wrap_layout :inner do %> + <% content_for :sidebar do %> +

OUTSCALE

+ + + + <%= partial("layouts/otherdocs", :locals => { :skip => "Terraform Enterprise" }) %> + <% end %> + <%= yield %> +<% end %> +""" + if not os.path.exists(navbar_dirpath): + os.makedirs(navbar_dirpath) + if not os.path.exists(index_dirpath): + os.makedirs(index_dirpath) + with io.open('{}/outscale.erb'.format(navbar_dirpath), + 'w', encoding='utf-8') as f: + f.write(navbar_file) + +if __name__ == '__main__': + main() diff --git a/docs/osc-api b/docs/osc-api new file mode 160000 index 000000000..f58e42820 --- /dev/null +++ b/docs/osc-api @@ -0,0 +1 @@ +Subproject commit f58e42820620dc51167c7385779497dd9cd7a6df diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..c09210dab --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +prance +pyyaml +openapi-spec-validator \ No newline at end of file diff --git a/scripts/generate-doc.sh b/scripts/generate-doc.sh new file mode 100755 index 000000000..4b9a742a9 --- /dev/null +++ b/scripts/generate-doc.sh @@ -0,0 +1,26 @@ +#!/bin/sh + +project_dir=$(cd "$(dirname $0)" && pwd) +project_root=$(cd $project_dir/.. && pwd) +docs_dir="${project_root}/docs" +output_dir="${project_root}/" + +python3 -m venv "${docs_dir}/.venv" +. "${docs_dir}/.venv/bin/activate" + +pip3 install -r "${docs_dir}/requirements.txt" 1>"${docs_dir}/generation_log.txt" 2>&1 \ +&& python3 "${docs_dir}/generate_doc_terraform.py" \ + --provider_directory "${project_root}/outscale/" \ + --api "${docs_dir}/osc-api/outscale.yaml" \ + --output_directory "$output_dir" \ + --template_directory "${docs_dir}/doc-terraform-template/" 1>"${docs_dir}/generation_log.txt" 2>&1 +RES=$? +deactivate + +if [ $RES -ne 0 ]; then + echo "KO, see logs in ${docs_dir}/generation_log.txt" +else + echo "OK" +fi + +exit $RES \ No newline at end of file From 1f2318286a973204a85c06a985cff1db681b8522 Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Tue, 30 Nov 2021 15:38:41 +0000 Subject: [PATCH 02/11] Checkout to v0.5.0 --- docs/doc-terraform-template | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/doc-terraform-template b/docs/doc-terraform-template index 0d6765412..ee3d6bf9d 160000 --- a/docs/doc-terraform-template +++ b/docs/doc-terraform-template @@ -1 +1 @@ -Subproject commit 0d6765412fd5519c8dbf5d2483b0f836e562c6ec +Subproject commit ee3d6bf9d04cd192fe5ecf3499208037e6f6a431 From ec551a80e0d9b5eb9755aeb7a2f9578555a8fbf5 Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Tue, 30 Nov 2021 15:39:01 +0000 Subject: [PATCH 03/11] Sync script with api-framework --- docs/generate_doc_terraform.py | 105 ++++++++++++++++++++++++++------- docs/utils.py | 10 ++++ 2 files changed, 93 insertions(+), 22 deletions(-) create mode 100644 docs/utils.py diff --git a/docs/generate_doc_terraform.py b/docs/generate_doc_terraform.py index 47a9aeaa3..48febd991 100644 --- a/docs/generate_doc_terraform.py +++ b/docs/generate_doc_terraform.py @@ -8,12 +8,11 @@ import shutil import os import yaml +# Local +import utils -import gtw.api.openapi.parser as openapi_parser -import gtw.api.schema as schema -import gtw.api.utils as utils - -# NOTE : python3 generate_doc_terraform.py --provider_directory /Users/mercatguillaume/workspace/terraform-provider-outscale/outscale --api /Users/mercatguillaume/workspace/osc-api/outscale.yaml --output_directory /Users/mercatguillaume/workspace/output_test --template_directory /Users/mercatguillaume/workspace/api-framework/terraform_template +from osc_openapi_framework import parser as openapi_parser, schema +from enum import Enum, auto parser = argparse.ArgumentParser(description='Generate documentation terraform') parser.add_argument('--new_format', action='store_true') @@ -27,6 +26,18 @@ ARGS = parser.parse_args() +# Data Sources that need to be consider as singular +FORCE_SINGULAR_LIST = ["net_attributes", "quotas"] +# Data Sources that need to be consider as plural +FORCE_PLURAL_LIST = ["flexible_gpu_catalog", "load_balancer_vm_health"] + +class DataType(Enum): + SINGULAR = auto() + PLURAL = auto() + FORCE_PLURAL = auto() + FORCE_SINGULAR = auto() + RESOURCE = auto() + def print_dict(item, path, profondeur): result = str() if isinstance(item, schema.ObjectField): @@ -156,9 +167,18 @@ def addField(field_object, key, value): if isinstance(field_object, schema.ObjectField): if key_split[0] in field_object.properties: addField(field_object.properties[key_split[0]], key_split[1], value) + else: + print("[WARNING] The key does not exist") + elif isinstance(field_object, schema.ArrayField): + if isinstance(field_object.item, schema.ObjectField): + if key_split[0] in field_object.item.properties: + addField(field_object.item.properties[key_split[0]], key_split[1],value) + else: + print("[WARNING] The key does not exist") + elif isinstance(field_object, dict): + addField(field_object[key_split[0]], key_split[1], value) else: - if key_split[0] in field_object: - addField(field_object[key_split[0]], key_split[1], value) + print("[WARNING] case not implement What: addField Type: {}".format(type(field_object))) else: new_obj = schema.ObjectField({}, key, 'object', 'in', 'toto', description=value) if isinstance(field_object, schema.ObjectField): @@ -174,7 +194,21 @@ def addField(field_object, key, value): def renameField(field_object, key, value): if '.' in key: key_split = key.split('.', 1) - renameField(field_object[key_split[0]], key_split[1], value) + if isinstance(field_object, schema.ObjectField): + if key_split[0] in field_object.properties: + renameField(field_object.properties[key_split[0]], key_split[1], value) + else: + print("[WARNING] The key does not exist") + elif isinstance(field_object, schema.ArrayField): + if isinstance(field_object.item, schema.ObjectField): + if key_split[0] in field_object.item.properties: + renameField(field_object.item.properties[key_split[0]], key_split[1],value) + else: + print("[WARNING] The key does not exist") + elif isinstance(field_object, dict): + renameField(field_object[key_split[0]], key_split[1], value) + else: + print("[WARNING] case not implement What: renameField Type: {}".format(type(field_object))) else: if isinstance(field_object, schema.ObjectField): if key in field_object.properties.keys(): @@ -228,7 +262,21 @@ def renameField(field_object, key, value): def removeField(field_object, key): if '.' in key: key_split = key.split('.', 1) - removeField(field_object[key_split[0]], key_split[1]) + if isinstance(field_object, schema.ObjectField): + if key_split[0] in field_object.properties: + removeField(field_object.properties[key_split[0]], key_split[1]) + else: + print("[WARNING] The key does not exist") + elif isinstance(field_object, schema.ArrayField): + if isinstance(field_object.item, schema.ObjectField): + if key_split[0] in field_object.item.properties: + removeField(field_object.item.properties[key_split[0]], key_split[1]) + else: + print("[WARNING] The key does not exist") + elif isinstance(field_object, dict): + removeField(field_object[key_split[0]], key_split[1]) + else: + print("[WARNING] case not implement What: removeField Type: {}".format(type(field_object))) else: if isinstance(field_object, schema.ObjectField): if key in field_object.properties.keys(): @@ -261,8 +309,11 @@ def treatAddPropData(field_to_update, part_to_update, addprop_content): removeField(field_to_update, new_k) -def file_template(template, links, resource_name, is_singular, input_field, output_field, example_content, import_content): - resource_name_singular = resource_name if is_singular else resource_name[:-1] +def file_template(template, links, resource_name, data_type, input_field, output_field, example_content, import_content): + if data_type in [DataType.SINGULAR, DataType.FORCE_PLURAL, DataType.RESOURCE]: + resource_name_singular = resource_name + else: + resource_name_singular = resource_name[:-1] placeholders = links.get(resource_name_singular, 'NOT_FOUND {}'.format(resource_name_singular)) print('======= placeholders -> {}'.format(placeholders)) @@ -384,7 +435,7 @@ def main(): resource_name = str() code_filename = '{}/{}'.format( ARGS.provider_directory, filename[len('outscale/')+1:]) - is_singular = True + data_type = DataType.RESOURCE if 'data_source' in name: dirpath = ARGS.output_directory + ( @@ -411,13 +462,22 @@ def main(): addprop_content = yaml.load(f, yaml.FullLoader) except FileNotFoundError as e: pass + if resource_name == 'vms_state': template = template_datasources - is_singular = False + data_type = DataType.PLURAL resource_name = 'vm_states' - elif resource_name[-1] == 's': + elif (resource_name[-1] == 's' and resource_name not in FORCE_SINGULAR_LIST): + # Has an S in the name and is not a plural exception + template = template_datasources + data_type = DataType.PLURAL + elif resource_name in FORCE_PLURAL_LIST: template = template_datasources - is_singular = False + data_type = DataType.FORCE_PLURAL + elif resource_name in FORCE_SINGULAR_LIST: + data_type = DataType.FORCE_SINGULAR + else: + data_type= DataType.SINGULAR elif 'resource' in name: dirpath = ARGS.output_directory + ( '/docs/resources' if ARGS.new_format else '/website/docs/r') @@ -468,7 +528,8 @@ def main(): print(' - Remove double (Sing/Plur) in output fileds') for k in list(call_complete.output_fields.keys()): if k[-1] == 's' and k[:-1] in call_complete.output_fields.keys(): - if is_singular: + # Remove the real singular name + if data_type in [DataType.SINGULAR, DataType.FORCE_PLURAL, DataType.RESOURCE]: print('del {}'.format(k)) del call_complete.output_fields[k] else: @@ -476,7 +537,8 @@ def main(): del call_complete.output_fields[k[:-1]] print(' - Change output fields format for singular data source and resources') - if is_singular or 'resource' in name: + # For singular data source and resources, we need to remove the root node + if data_type in [DataType.SINGULAR, DataType.FORCE_SINGULAR, DataType.RESOURCE]: update_fields = dict() for k in list(call_complete.output_fields.keys()): if k == 'ResponseContext': @@ -484,7 +546,6 @@ def main(): continue print("Exploring {}".format(k)) value = call_complete.output_fields[k] - print("What ?  {}, Type ? {}".format(k, type(value))) if isinstance(value, schema.ArrayField): if isinstance(value.item, schema.ObjectField): for inner_k in value.item.properties.keys(): @@ -493,7 +554,6 @@ def main(): update_fields[inner_k] = value.item[inner_k] else: print("Who are you ? ... What: {} Type:{}".format(inner_k, type(value.item))) - exit(1) elif isinstance(value, schema.ObjectField): for inner_k in value.properties.keys(): update_fields[inner_k] = value.properties[inner_k] @@ -507,11 +567,9 @@ def main(): print(' - Treating addprop data') input_field_to_update = call_complete.input_fields if call_complete else {} if not ARGS.no_addapt: - print("Exploring argument addprop") treatAddPropData(input_field_to_update, 'argument', addprop_content) output_field_to_update = call_complete.output_fields if call_complete else {} if not ARGS.no_addapt: - print("Exploring attributes addprop") treatAddPropData(output_field_to_update, 'attribute', addprop_content) print(' - Treating input parameters ...') @@ -542,7 +600,7 @@ def main(): content_file = file_template(template, links, resource_name, - is_singular, + data_type, str_input, str_output, example_content, @@ -593,5 +651,8 @@ def main(): 'w', encoding='utf-8') as f: f.write(navbar_file) + shutil.copyfile('{}/index{}'.format(ARGS.template_directory, extention), + '{}/index{}'.format(index_dirpath, extention)) + if __name__ == '__main__': main() diff --git a/docs/utils.py b/docs/utils.py new file mode 100644 index 000000000..59c884cd5 --- /dev/null +++ b/docs/utils.py @@ -0,0 +1,10 @@ +import re + +def camel_case_to_snake_case(value): + """Convert from camel case to snake case.""" + # re.sub works on non overlapping occurencies only. + s1 = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', value) + return re.sub('([a-z0-9])([A-Z])', r'\1_\2', s1).lower() + +def snake_case_to_camel_case(value): + return ''.join([x.title() for x in value.split('_') or []]) \ No newline at end of file From ac21233804b0c31799644ed72a2f5cef6e1b86da Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Tue, 30 Nov 2021 15:48:34 +0000 Subject: [PATCH 04/11] Fix the file not found error --- docs/generate_doc_terraform.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/generate_doc_terraform.py b/docs/generate_doc_terraform.py index 48febd991..54fd3c855 100644 --- a/docs/generate_doc_terraform.py +++ b/docs/generate_doc_terraform.py @@ -651,8 +651,5 @@ def main(): 'w', encoding='utf-8') as f: f.write(navbar_file) - shutil.copyfile('{}/index{}'.format(ARGS.template_directory, extention), - '{}/index{}'.format(index_dirpath, extention)) - if __name__ == '__main__': main() From 0e53f0e1d99cab0312580cd8536295af3e62cd81 Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Wed, 15 Dec 2021 13:25:12 +0000 Subject: [PATCH 05/11] Add the official osc-openapi-framework module --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index c09210dab..530612760 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ prance pyyaml -openapi-spec-validator \ No newline at end of file +openapi-spec-validator +osc-openapi-framework \ No newline at end of file From 607bce1fc12c4a4ac00ba2f8626fc9370a919dcb Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Wed, 15 Dec 2021 13:25:43 +0000 Subject: [PATCH 06/11] Generate doc from makefile --- GNUmakefile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/GNUmakefile b/GNUmakefile index 920d84e09..1cd0646f5 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -78,4 +78,7 @@ examples-test: cd ../..; \ done\ +doc: + @sh -c "'$(CURDIR)/scripts/generate-doc.sh'" + .PHONY: build test testacc fmt fmtcheck lint tools test-compile website website-lint website-test examples-test website-local From d1ad9e05c06fd8f05d69997687f27d71ed645741 Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Wed, 15 Dec 2021 13:29:27 +0000 Subject: [PATCH 07/11] Instruction for generating the documentation --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 869cbb354..f33d5298b 100644 --- a/README.md +++ b/README.md @@ -113,3 +113,14 @@ Issues and contributions ------------------------ Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more details. + + +Building the documentation +------------------------ +- Requirements: + - make + - python3 + - python-venv +```shell + $ make doc +``` \ No newline at end of file From f2b0d8dc8d455dbb38eddd6f70d889a3b4a15a1d Mon Sep 17 00:00:00 2001 From: Maxime Dufour Date: Thu, 23 Dec 2021 14:08:22 +0000 Subject: [PATCH 08/11] Fix the replacement of parameters with rename addprop --- docs/generate_doc_terraform.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/generate_doc_terraform.py b/docs/generate_doc_terraform.py index 54fd3c855..62f86b0a6 100644 --- a/docs/generate_doc_terraform.py +++ b/docs/generate_doc_terraform.py @@ -218,7 +218,7 @@ def renameField(field_object, key, value): field_object.properties[new_key] = old del field_object.properties[key] else: - new_key = value.get('name', key) + new_key = value.get('name', utils.camel_case_to_snake_case(key)) old.description = value.get('description', old.description) if utils.snake_case_to_camel_case(new_key) != key: field_object.properties[utils.snake_case_to_camel_case(new_key)] = old @@ -234,7 +234,7 @@ def renameField(field_object, key, value): field_object.item.properties[new_value] = old del field_object.item.properties[key] else: - new_key = value.get('name', key) + new_key = value.get('name', utils.camel_case_to_snake_case(key)) old.description = value.get('description', old.description) if utils.snake_case_to_camel_case(new_key) != key: field_object.item.properties[utils.snake_case_to_camel_case(new_key)] = old @@ -250,7 +250,7 @@ def renameField(field_object, key, value): field_object[new_value] = old del field_object[key] else: - new_key = value.get('name', key) + new_key = value.get('name', utils.camel_case_to_snake_case(key)) old.description = value.get('description', old.description) if utils.snake_case_to_camel_case(new_key) != key: field_object[utils.snake_case_to_camel_case(new_key)] = old From 2efd1c2852f25f7efade29e4049fb2785cb800bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9a=20Renou?= Date: Fri, 14 Jan 2022 13:50:00 +0100 Subject: [PATCH 09/11] Checkout to 1.16.0 --- docs/osc-api | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/osc-api b/docs/osc-api index f58e42820..cb440cdad 160000 --- a/docs/osc-api +++ b/docs/osc-api @@ -1 +1 @@ -Subproject commit f58e42820620dc51167c7385779497dd9cd7a6df +Subproject commit cb440cdad30e2b416afa4c7d4182e521f830282f From 69eab89f88707454f734daebe1d1b0281abcc70c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9a=20Renou?= Date: Tue, 8 Feb 2022 13:55:13 +0100 Subject: [PATCH 10/11] Update submodule link + fix typos --- .gitmodules | 2 +- docs/generate_doc_terraform.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.gitmodules b/.gitmodules index 69ffbbf53..f6a538a56 100644 --- a/.gitmodules +++ b/.gitmodules @@ -3,4 +3,4 @@ url = https://github.com/outscale/osc-api [submodule "docs/doc-terraform-template"] path = docs/doc-terraform-template - url = https://gitlab.outscale.internal/rd/doc-terraform-template.git + url = https://gitlab.outscale.internal/documentation/doc-terraform-template.git \ No newline at end of file diff --git a/docs/generate_doc_terraform.py b/docs/generate_doc_terraform.py index 62f86b0a6..f0e4c12b8 100644 --- a/docs/generate_doc_terraform.py +++ b/docs/generate_doc_terraform.py @@ -26,9 +26,9 @@ ARGS = parser.parse_args() -# Data Sources that need to be consider as singular +# Data Sources that need to be considered as singular FORCE_SINGULAR_LIST = ["net_attributes", "quotas"] -# Data Sources that need to be consider as plural +# Data Sources that need to be considered as plural FORCE_PLURAL_LIST = ["flexible_gpu_catalog", "load_balancer_vm_health"] class DataType(Enum): From 26bcd46ad3205a6673ddf5f492b9ea42edc187db Mon Sep 17 00:00:00 2001 From: Outscale Bot Date: Thu, 10 Mar 2022 14:00:20 +0000 Subject: [PATCH 11/11] Release Documentation 0.5.2 Signed-off-by: Outscale Bot --- docs/doc-terraform-template | 2 +- website/docs/d/access_key.html.markdown | 2 +- website/docs/d/access_keys.html.markdown | 2 +- website/docs/d/client_gateway.html.markdown | 2 +- website/docs/d/client_gateways.html.markdown | 2 +- website/docs/d/dhcp_option.html.markdown | 2 +- website/docs/d/dhcp_options.html.markdown | 2 +- website/docs/d/flexible_gpu.html.markdown | 2 +- .../docs/d/flexible_gpu_catalog.html.markdown | 2 +- website/docs/d/flexible_gpus.html.markdown | 2 +- website/docs/d/image.html.markdown | 2 +- .../docs/d/image_export_task.html.markdown | 2 +- .../docs/d/image_export_tasks.html.markdown | 2 +- website/docs/d/images.html.markdown | 2 +- website/docs/d/internet_service.html.markdown | 4 +-- .../docs/d/internet_services.html.markdown | 4 +-- website/docs/d/keypair.html.markdown | 2 +- website/docs/d/keypairs.html.markdown | 2 +- website/docs/d/load_balancer.html.markdown | 6 ++-- .../load_balancer_listener_rule.html.markdown | 2 +- ...load_balancer_listener_rules.html.markdown | 2 +- .../d/load_balancer_vm_health.html.markdown | 2 +- website/docs/d/load_balancers.html.markdown | 6 ++-- website/docs/d/nat_service.html.markdown | 8 ++--- website/docs/d/nat_services.html.markdown | 8 ++--- website/docs/d/net.html.markdown | 2 +- website/docs/d/net_access_point.html.markdown | 2 +- .../d/net_access_point_services.html.markdown | 2 +- .../docs/d/net_access_points.html.markdown | 2 +- website/docs/d/net_attributes.html.markdown | 2 +- website/docs/d/net_peering.html.markdown | 2 +- website/docs/d/net_peerings.html.markdown | 2 +- website/docs/d/nets.html.markdown | 2 +- website/docs/d/nic.html.markdown | 36 +++++++++---------- website/docs/d/nics.html.markdown | 36 +++++++++---------- website/docs/d/product_type.html.markdown | 2 +- website/docs/d/product_types.html.markdown | 2 +- website/docs/d/public_ip.html.markdown | 32 ++++++++--------- website/docs/d/public_ips.html.markdown | 34 +++++++++--------- website/docs/d/quota.html.markdown | 2 +- website/docs/d/quotas.html.markdown | 6 ++-- website/docs/d/regions.html.markdown | 2 +- website/docs/d/route_table.html.markdown | 2 +- website/docs/d/route_tables.html.markdown | 2 +- website/docs/d/security_group.html.markdown | 2 +- website/docs/d/security_groups.html.markdown | 2 +- .../docs/d/server_certificate.html.markdown | 2 +- .../docs/d/server_certificates.html.markdown | 2 +- website/docs/d/snapshot.html.markdown | 2 +- .../docs/d/snapshot_export_task.html.markdown | 2 +- .../d/snapshot_export_tasks.html.markdown | 2 +- website/docs/d/snapshots.html.markdown | 2 +- website/docs/d/subnet.html.markdown | 4 +-- website/docs/d/subnets.html.markdown | 4 +-- website/docs/d/subregions.html.markdown | 2 +- website/docs/d/virtual_gateway.html.markdown | 2 +- website/docs/d/virtual_gateways.html.markdown | 2 +- website/docs/d/vm.html.markdown | 16 ++++----- website/docs/d/vm_state.html.markdown | 4 +-- website/docs/d/vm_states.html.markdown | 4 +-- website/docs/d/vm_types.html.markdown | 2 +- website/docs/d/vms.html.markdown | 16 ++++----- website/docs/d/volume.html.markdown | 2 +- website/docs/d/volumes.html.markdown | 2 +- website/docs/d/vpn_connection.html.markdown | 2 +- website/docs/d/vpn_connections.html.markdown | 2 +- website/docs/r/access_key.html.markdown | 4 +-- website/docs/r/client_gateway.html.markdown | 2 +- website/docs/r/dhcp_option.html.markdown | 2 +- website/docs/r/flexible_gpu.html.markdown | 2 +- .../docs/r/flexible_gpu_link.html.markdown | 4 +-- website/docs/r/image.html.markdown | 2 +- .../docs/r/image_export_task.html.markdown | 2 +- .../r/image_launch_permission.html.markdown | 2 +- website/docs/r/internet_service.html.markdown | 4 +-- .../r/internet_service_link.html.markdown | 2 +- website/docs/r/keypair.html.markdown | 4 +-- website/docs/r/load_balancer.html.markdown | 6 ++-- .../r/load_balancer_attributes.html.markdown | 12 +++---- .../load_balancer_listener_rule.html.markdown | 2 +- .../docs/r/load_balancer_policy.html.markdown | 6 ++-- .../docs/r/load_balancer_vms.html.markdown | 2 +- website/docs/r/nat_service.html.markdown | 12 +++---- website/docs/r/net.html.markdown | 2 +- website/docs/r/net_access_point.html.markdown | 2 +- website/docs/r/net_attributes.html.markdown | 2 +- website/docs/r/net_peering.html.markdown | 2 +- .../r/net_peering_acceptation.html.markdown | 2 +- website/docs/r/nic.html.markdown | 24 ++++++------- website/docs/r/nic_link.html.markdown | 2 +- website/docs/r/nic_private_ip.html.markdown | 2 +- website/docs/r/public_ip.html.markdown | 16 ++++----- website/docs/r/public_ip_link.html.markdown | 12 +++---- website/docs/r/route.html.markdown | 2 +- website/docs/r/route_table.html.markdown | 2 +- website/docs/r/route_table_link.html.markdown | 2 +- website/docs/r/security_group.html.markdown | 2 +- .../docs/r/security_group_rule.html.markdown | 2 +- .../docs/r/server_certificate.html.markdown | 2 +- website/docs/r/snapshot.html.markdown | 2 +- .../docs/r/snapshot_attributes.html.markdown | 2 +- .../docs/r/snapshot_export_task.html.markdown | 2 +- website/docs/r/subnet.html.markdown | 4 +-- website/docs/r/virtual_gateway.html.markdown | 2 +- .../docs/r/virtual_gateway_link.html.markdown | 2 +- ...al_gateway_route_propagation.html.markdown | 2 +- website/docs/r/vm.html.markdown | 20 +++++------ website/docs/r/volume.html.markdown | 4 +-- website/docs/r/volumes_link.html.markdown | 2 +- website/docs/r/vpn_connection.html.markdown | 2 +- .../docs/r/vpn_connection_route.html.markdown | 2 +- 111 files changed, 260 insertions(+), 260 deletions(-) diff --git a/docs/doc-terraform-template b/docs/doc-terraform-template index ee3d6bf9d..b2d4a725d 160000 --- a/docs/doc-terraform-template +++ b/docs/doc-terraform-template @@ -1 +1 @@ -Subproject commit ee3d6bf9d04cd192fe5ecf3499208037e6f6a431 +Subproject commit b2d4a725d2e16569141b691eb97510f596edb0f5 diff --git a/website/docs/d/access_key.html.markdown b/website/docs/d/access_key.html.markdown index 2ac2da4c0..fba3178a4 100644 --- a/website/docs/d/access_key.html.markdown +++ b/website/docs/d/access_key.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_access_key Data Source Provides information about a specific access key. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Access+Keys). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Access-Keys.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-accesskey). ## Example Usage diff --git a/website/docs/d/access_keys.html.markdown b/website/docs/d/access_keys.html.markdown index 7440d5cf2..7918bc1b4 100644 --- a/website/docs/d/access_keys.html.markdown +++ b/website/docs/d/access_keys.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_access_keys Data Source Provides information about access keys. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Access+Keys). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Access-Keys.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-accesskey). ## Example Usage diff --git a/website/docs/d/client_gateway.html.markdown b/website/docs/d/client_gateway.html.markdown index dc15c4ef8..ee9f29a38 100644 --- a/website/docs/d/client_gateway.html.markdown +++ b/website/docs/d/client_gateway.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_client_gateway Data Source Provides information about a specific client gateway. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Customer+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Customer-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-clientgateway). ## Example Usage diff --git a/website/docs/d/client_gateways.html.markdown b/website/docs/d/client_gateways.html.markdown index df04e0d42..e24fa6eae 100644 --- a/website/docs/d/client_gateways.html.markdown +++ b/website/docs/d/client_gateways.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_client_gateways Data Source Provides information about client gateways. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Customer+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Customer-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-clientgateway). ## Example Usage diff --git a/website/docs/d/dhcp_option.html.markdown b/website/docs/d/dhcp_option.html.markdown index 4dea32631..96f2e7c0a 100644 --- a/website/docs/d/dhcp_option.html.markdown +++ b/website/docs/d/dhcp_option.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_dhcp_option Data Source Provides information about a specific DHCP option. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+DHCP+Options). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-dhcpoption). ## Example Usage diff --git a/website/docs/d/dhcp_options.html.markdown b/website/docs/d/dhcp_options.html.markdown index 9aca89943..3eb651aea 100644 --- a/website/docs/d/dhcp_options.html.markdown +++ b/website/docs/d/dhcp_options.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_dhcp_options Data Source Provides information about DHCP options. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+DHCP+Options). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-dhcpoption). ## Example Usage diff --git a/website/docs/d/flexible_gpu.html.markdown b/website/docs/d/flexible_gpu.html.markdown index 32873725d..5ea00991e 100644 --- a/website/docs/d/flexible_gpu.html.markdown +++ b/website/docs/d/flexible_gpu.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_flexible_gpu Data Source Provides information about a specific flexible GPU. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Flexible+GPUs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-flexiblegpu). ## Example Usage diff --git a/website/docs/d/flexible_gpu_catalog.html.markdown b/website/docs/d/flexible_gpu_catalog.html.markdown index 6439f56ee..b92928e6a 100644 --- a/website/docs/d/flexible_gpu_catalog.html.markdown +++ b/website/docs/d/flexible_gpu_catalog.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_flexible_gpu_catalog Data Source Provides information about the flexible GPU catalog. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Flexible+GPUs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readflexiblegpucatalog). ## Example Usage diff --git a/website/docs/d/flexible_gpus.html.markdown b/website/docs/d/flexible_gpus.html.markdown index d55ad6efa..77e69bc47 100644 --- a/website/docs/d/flexible_gpus.html.markdown +++ b/website/docs/d/flexible_gpus.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_flexible_gpus Data Source Provides information about flexible GPUs. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Flexible+GPUs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-flexiblegpu). ## Example Usage diff --git a/website/docs/d/image.html.markdown b/website/docs/d/image.html.markdown index b08e9751c..cf986b087 100644 --- a/website/docs/d/image.html.markdown +++ b/website/docs/d/image.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_image Data Source Provides information about a specific image. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+OMIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-OMIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-image). ## Example Usage diff --git a/website/docs/d/image_export_task.html.markdown b/website/docs/d/image_export_task.html.markdown index fa32373f2..5f6f6a913 100644 --- a/website/docs/d/image_export_task.html.markdown +++ b/website/docs/d/image_export_task.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_image_export_task Data Source Provides information about a specific image export task. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+OMIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-OMIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-image). ## Example Usage diff --git a/website/docs/d/image_export_tasks.html.markdown b/website/docs/d/image_export_tasks.html.markdown index bb22ca7a8..b1ab87d04 100644 --- a/website/docs/d/image_export_tasks.html.markdown +++ b/website/docs/d/image_export_tasks.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_image_export_tasks Data Source Provides information about image export tasks. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+OMIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-OMIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-image). ## Example Usage diff --git a/website/docs/d/images.html.markdown b/website/docs/d/images.html.markdown index d02d47d80..160757495 100644 --- a/website/docs/d/images.html.markdown +++ b/website/docs/d/images.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_images Data Source Provides information about images. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+OMIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-OMIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-image). ## Example Usage diff --git a/website/docs/d/internet_service.html.markdown b/website/docs/d/internet_service.html.markdown index 8ed006012..0a59b8bdd 100644 --- a/website/docs/d/internet_service.html.markdown +++ b/website/docs/d/internet_service.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_internet_service Data Source Provides information about a specific Internet service. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Internet+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Internet-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-internetservice). ## Example Usage @@ -41,7 +41,7 @@ The following attributes are exported: * `internet_service_id` - The ID of the Internet service. * `net_id` - The ID of the Net attached to the Internet service. -* `state` - The state of the attachment of the Net to the Internet service (always `available`). +* `state` - The state of the attachment of the Internet service to the Net (always `available`). * `tags` - One or more tags associated with the Internet service. * `key` - The key of the tag, with a minimum of 1 character. * `value` - The value of the tag, between 0 and 255 characters. diff --git a/website/docs/d/internet_services.html.markdown b/website/docs/d/internet_services.html.markdown index fc8010f95..fdd3873dc 100644 --- a/website/docs/d/internet_services.html.markdown +++ b/website/docs/d/internet_services.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_internet_services Data Source Provides information about Internet services. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Internet+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Internet-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-internetservice). ## Example Usage @@ -42,7 +42,7 @@ The following attributes are exported: * `internet_services` - Information about one or more Internet services. * `internet_service_id` - The ID of the Internet service. * `net_id` - The ID of the Net attached to the Internet service. - * `state` - The state of the attachment of the Net to the Internet service (always `available`). + * `state` - The state of the attachment of the Internet service to the Net (always `available`). * `tags` - One or more tags associated with the Internet service. * `key` - The key of the tag, with a minimum of 1 character. * `value` - The value of the tag, between 0 and 255 characters. diff --git a/website/docs/d/keypair.html.markdown b/website/docs/d/keypair.html.markdown index a0ff305cb..73c6abccc 100644 --- a/website/docs/d/keypair.html.markdown +++ b/website/docs/d/keypair.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_keypair Data Source Provides information about a specific keypair. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Keypairs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Keypairs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-keypair). ## Example Usage diff --git a/website/docs/d/keypairs.html.markdown b/website/docs/d/keypairs.html.markdown index eb2918075..fb7906c08 100644 --- a/website/docs/d/keypairs.html.markdown +++ b/website/docs/d/keypairs.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_keypairs Data Source Provides information about keypairs. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Keypairs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Keypairs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-keypair). ## Example Usage diff --git a/website/docs/d/load_balancer.html.markdown b/website/docs/d/load_balancer.html.markdown index 235df84c3..84f9ef212 100644 --- a/website/docs/d/load_balancer.html.markdown +++ b/website/docs/d/load_balancer.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer Data Source Provides information about a specific load balancer. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-loadbalancer). ## Example Usage @@ -35,7 +35,7 @@ The following arguments are supported: The following attributes are exported: * `access_log` - Information about access logs. - * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `osu_bucket_name` parameter is required. + * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. * `osu_bucket_name` - The name of the OOS bucket for the access logs. * `osu_bucket_prefix` - The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). * `publication_interval` - The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either 5 or 60 (by default, 60). @@ -63,7 +63,7 @@ The following attributes are exported: * `load_balancer_sticky_cookie_policies` - The policies defined for the load balancer. * `policy_name` - The name of the stickiness policy. * `load_balancer_type` - The type of load balancer. Valid only for load balancers in a Net.
-If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP address.
+If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.
If `LoadBalancerType` is `internal`, the load balancer has a public DNS name that resolves to a private IP address. * `net_id` - The ID of the Net for the load balancer. * `security_groups` - One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net. diff --git a/website/docs/d/load_balancer_listener_rule.html.markdown b/website/docs/d/load_balancer_listener_rule.html.markdown index 253c3a690..6c01fc7d5 100644 --- a/website/docs/d/load_balancer_listener_rule.html.markdown +++ b/website/docs/d/load_balancer_listener_rule.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer_listener_rule Data Source Provides information about a specific load balancer listener rule. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-listener). ## Example Usage diff --git a/website/docs/d/load_balancer_listener_rules.html.markdown b/website/docs/d/load_balancer_listener_rules.html.markdown index 92a55d4f5..bfef3b1b0 100644 --- a/website/docs/d/load_balancer_listener_rules.html.markdown +++ b/website/docs/d/load_balancer_listener_rules.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer_listener_rules Data Source Provides information about load balancer listener rules. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-listener). ## Example Usage diff --git a/website/docs/d/load_balancer_vm_health.html.markdown b/website/docs/d/load_balancer_vm_health.html.markdown index 4398477d4..83e2c6b7c 100644 --- a/website/docs/d/load_balancer_vm_health.html.markdown +++ b/website/docs/d/load_balancer_vm_health.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer_vm_health Data Source Provides information about the health of one or more back-end VMs registered with a specific load balancer. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readvmshealth). ## Example Usage diff --git a/website/docs/d/load_balancers.html.markdown b/website/docs/d/load_balancers.html.markdown index 66f3b483c..438388ab6 100644 --- a/website/docs/d/load_balancers.html.markdown +++ b/website/docs/d/load_balancers.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancers Data Source Provides information about load balancers. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-loadbalancer). ## Example Usage @@ -36,7 +36,7 @@ The following attributes are exported: * `load_balancers` - Information about one or more load balancers. * `access_log` - Information about access logs. - * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `osu_bucket_name` parameter is required. + * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. * `osu_bucket_name` - The name of the OOS bucket for the access logs. * `osu_bucket_prefix` - The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). * `publication_interval` - The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either 5 or 60 (by default, 60). @@ -64,7 +64,7 @@ The following attributes are exported: * `load_balancer_sticky_cookie_policies` - The policies defined for the load balancer. * `policy_name` - The name of the stickiness policy. * `load_balancer_type` - The type of load balancer. Valid only for load balancers in a Net.
-If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP address.
+If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.
If `LoadBalancerType` is `internal`, the load balancer has a public DNS name that resolves to a private IP address. * `net_id` - The ID of the Net for the load balancer. * `security_groups` - One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net. diff --git a/website/docs/d/nat_service.html.markdown b/website/docs/d/nat_service.html.markdown index 5dcc069b8..1dc79e9cb 100644 --- a/website/docs/d/nat_service.html.markdown +++ b/website/docs/d/nat_service.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nat_service Data Source Provides information about a specific NAT service. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+NAT+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-NAT-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-natservice). ## Example Usage @@ -42,9 +42,9 @@ The following attributes are exported: * `nat_service_id` - The ID of the NAT service. * `net_id` - The ID of the Net in which the NAT service is. -* `public_ips` - Information about the External IP address or addresses (EIPs) associated with the NAT service. - * `public_ip` - The External IP address (EIP) associated with the NAT service. - * `public_ip_id` - The allocation ID of the EIP associated with the NAT service. +* `public_ips` - Information about the public IP or IPs associated with the NAT service. + * `public_ip` - The public IP associated with the NAT service. + * `public_ip_id` - The allocation ID of the public IP associated with the NAT service. * `state` - The state of the NAT service (`pending` \| `available` \| `deleting` \| `deleted`). * `subnet_id` - The ID of the Subnet in which the NAT service is. * `tags` - One or more tags associated with the NAT service. diff --git a/website/docs/d/nat_services.html.markdown b/website/docs/d/nat_services.html.markdown index f23d06a96..e781dd9c6 100644 --- a/website/docs/d/nat_services.html.markdown +++ b/website/docs/d/nat_services.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nat_services Data Source Provides information about NAT services. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+NAT+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-NAT-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-natservice). ## Example Usage @@ -43,9 +43,9 @@ The following attributes are exported: * `nat_services` - Information about one or more NAT services. * `nat_service_id` - The ID of the NAT service. * `net_id` - The ID of the Net in which the NAT service is. - * `public_ips` - Information about the External IP address or addresses (EIPs) associated with the NAT service. - * `public_ip` - The External IP address (EIP) associated with the NAT service. - * `public_ip_id` - The allocation ID of the EIP associated with the NAT service. + * `public_ips` - Information about the public IP or IPs associated with the NAT service. + * `public_ip` - The public IP associated with the NAT service. + * `public_ip_id` - The allocation ID of the public IP associated with the NAT service. * `state` - The state of the NAT service (`pending` \| `available` \| `deleting` \| `deleted`). * `subnet_id` - The ID of the Subnet in which the NAT service is. * `tags` - One or more tags associated with the NAT service. diff --git a/website/docs/d/net.html.markdown b/website/docs/d/net.html.markdown index 8574f8711..67cbea999 100644 --- a/website/docs/d/net.html.markdown +++ b/website/docs/d/net.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net Data Source Provides information about a specific Net. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPCs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPCs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-net). ## Example Usage diff --git a/website/docs/d/net_access_point.html.markdown b/website/docs/d/net_access_point.html.markdown index 4cd9b64bc..825d3cf77 100644 --- a/website/docs/d/net_access_point.html.markdown +++ b/website/docs/d/net_access_point.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_access_point Data Source Provides information about a specific Net access point. -For more information on this resource, see the [User Guide](https://wiki.outscale.internal/display/EN/About+VPC+Endpoints). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Endpoints.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netaccesspoint). ## Example Usage diff --git a/website/docs/d/net_access_point_services.html.markdown b/website/docs/d/net_access_point_services.html.markdown index 006d2c18b..903f482ee 100644 --- a/website/docs/d/net_access_point_services.html.markdown +++ b/website/docs/d/net_access_point_services.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_access_point_services Data Source Provides information about Net access point services. -For more information on this resource, see the [User Guide](https://wiki.outscale.internal/display/EN/About+VPC+Endpoints). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Endpoints.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netaccesspoint). ## Example Usage diff --git a/website/docs/d/net_access_points.html.markdown b/website/docs/d/net_access_points.html.markdown index c480d56e8..cfc86b018 100644 --- a/website/docs/d/net_access_points.html.markdown +++ b/website/docs/d/net_access_points.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_access_points Data Source Provides information about Net access points. -For more information on this resource, see the [User Guide](https://wiki.outscale.internal/display/EN/About+VPC+Endpoints). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Endpoints.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netaccesspoint). ## Example Usage diff --git a/website/docs/d/net_attributes.html.markdown b/website/docs/d/net_attributes.html.markdown index 84b7992b2..98a0868a3 100644 --- a/website/docs/d/net_attributes.html.markdown +++ b/website/docs/d/net_attributes.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_attributes Data Source Provides information about a specific Net attributes. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+DHCP+Options). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#updatenet). ## Example Usage diff --git a/website/docs/d/net_peering.html.markdown b/website/docs/d/net_peering.html.markdown index 555fc9119..5e789e0e4 100644 --- a/website/docs/d/net_peering.html.markdown +++ b/website/docs/d/net_peering.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_peering Data Source Provides information about a specific Net peering. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPC+Peering+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Peering-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netpeering). ## Example Usage diff --git a/website/docs/d/net_peerings.html.markdown b/website/docs/d/net_peerings.html.markdown index 8903438cb..6fb8a2784 100644 --- a/website/docs/d/net_peerings.html.markdown +++ b/website/docs/d/net_peerings.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_peerings Data Source Provides information about Net peerings. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPC+Peering+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Peering-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netpeering). ## Example Usage diff --git a/website/docs/d/nets.html.markdown b/website/docs/d/nets.html.markdown index 3790e416a..97b65ec55 100644 --- a/website/docs/d/nets.html.markdown +++ b/website/docs/d/nets.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nets Data Source Provides information about Nets. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPCs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPCs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-net). ## Example Usage diff --git a/website/docs/d/nic.html.markdown b/website/docs/d/nic.html.markdown index 704e80104..0c41e37ef 100644 --- a/website/docs/d/nic.html.markdown +++ b/website/docs/d/nic.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nic Data Source Provides information about a specific network interface card (NIC). -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+FNIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-FNIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-nic). ## Example Usage @@ -36,17 +36,17 @@ The following arguments are supported: * `link_nic_states` - (Optional) The states of the attachments. * `link_nic_vm_account_ids` - (Optional) The account IDs of the owners of the VMs the NICs are attached to. * `link_nic_vm_ids` - (Optional) The IDs of the VMs the NICs are attached to. - * `link_public_ip_account_ids` - (Optional) The account IDs of the owners of the EIPs associated with the NICs. - * `link_public_ip_link_public_ip_ids` - (Optional) The association IDs returned when the EIPs were associated with the NICs. - * `link_public_ip_public_ip_ids` - (Optional) The allocation IDs returned when the EIPs were allocated to their accounts. - * `link_public_ip_public_ips` - (Optional) The EIPs associated with the NICs. + * `link_public_ip_account_ids` - (Optional) The account IDs of the owners of the public IPs associated with the NICs. + * `link_public_ip_link_public_ip_ids` - (Optional) The association IDs returned when the public IPs were associated with the NICs. + * `link_public_ip_public_ip_ids` - (Optional) The allocation IDs returned when the public IPs were allocated to their accounts. + * `link_public_ip_public_ips` - (Optional) The public IPs associated with the NICs. * `mac_addresses` - (Optional) The Media Access Control (MAC) addresses of the NICs. * `net_ids` - (Optional) The IDs of the Nets where the NICs are located. * `nic_ids` - (Optional) The IDs of the NICs. * `private_dns_names` - (Optional) The private DNS names associated with the primary private IP addresses. - * `private_ips_link_public_ip_account_ids` - (Optional) The account IDs of the owner of the EIPs associated with the private IP addresses. - * `private_ips_link_public_ip_public_ips` - (Optional) The EIPs associated with the private IP addresses. - * `private_ips_primary_ip` - (Optional) The primary private IP addresses of the NICs. + * `private_ips_link_public_ip_account_ids` - (Optional) The account IDs of the owner of the public IPs associated with the private IP addresses. + * `private_ips_link_public_ip_public_ips` - (Optional) The public IPs associated with the private IP addresses. + * `private_ips_primary_ip` - (Optional) Whether the private IP address is the primary IP address associated with the NIC. * `private_ips_private_ips` - (Optional) The private IP addresses of the NICs. * `security_group_ids` - (Optional) The IDs of the security groups associated with the NICs. * `security_group_names` - (Optional) The names of the security groups associated with the NICs. @@ -71,24 +71,24 @@ The following attributes are exported: * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). * `vm_account_id` - The account ID of the owner of the VM. * `vm_id` - The ID of the VM. -* `link_public_ip` - Information about the EIP association. - * `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. +* `link_public_ip` - Information about the public IP association. + * `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. - * `public_ip_id` - The allocation ID of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. + * `public_ip_id` - The allocation ID of the public IP. * `mac_address` - The Media Access Control (MAC) address of the NIC. * `net_id` - The ID of the Net for the NIC. * `nic_id` - The ID of the NIC. * `private_dns_name` - The name of the private DNS. * `private_ips` - The private IP addresses of the NIC. * `is_primary` - If true, the IP address is the primary private IP address of the NIC. - * `link_public_ip` - Information about the EIP association. - * `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. + * `link_public_ip` - Information about the public IP association. + * `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. - * `public_ip_id` - The allocation ID of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. + * `public_ip_id` - The allocation ID of the public IP. * `private_dns_name` - The name of the private DNS. * `private_ip` - The private IP address of the NIC. * `security_groups` - One or more IDs of security groups for the NIC. diff --git a/website/docs/d/nics.html.markdown b/website/docs/d/nics.html.markdown index c9d57d407..0bb01acef 100644 --- a/website/docs/d/nics.html.markdown +++ b/website/docs/d/nics.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nics Data Source Provides information about network interface cards (NICs). -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+FNIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-FNIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-nic). ## Example Usage @@ -36,17 +36,17 @@ The following arguments are supported: * `link_nic_states` - (Optional) The states of the attachments. * `link_nic_vm_account_ids` - (Optional) The account IDs of the owners of the VMs the NICs are attached to. * `link_nic_vm_ids` - (Optional) The IDs of the VMs the NICs are attached to. - * `link_public_ip_account_ids` - (Optional) The account IDs of the owners of the EIPs associated with the NICs. - * `link_public_ip_link_public_ip_ids` - (Optional) The association IDs returned when the EIPs were associated with the NICs. - * `link_public_ip_public_ip_ids` - (Optional) The allocation IDs returned when the EIPs were allocated to their accounts. - * `link_public_ip_public_ips` - (Optional) The EIPs associated with the NICs. + * `link_public_ip_account_ids` - (Optional) The account IDs of the owners of the public IPs associated with the NICs. + * `link_public_ip_link_public_ip_ids` - (Optional) The association IDs returned when the public IPs were associated with the NICs. + * `link_public_ip_public_ip_ids` - (Optional) The allocation IDs returned when the public IPs were allocated to their accounts. + * `link_public_ip_public_ips` - (Optional) The public IPs associated with the NICs. * `mac_addresses` - (Optional) The Media Access Control (MAC) addresses of the NICs. * `net_ids` - (Optional) The IDs of the Nets where the NICs are located. * `nic_ids` - (Optional) The IDs of the NICs. * `private_dns_names` - (Optional) The private DNS names associated with the primary private IP addresses. - * `private_ips_link_public_ip_account_ids` - (Optional) The account IDs of the owner of the EIPs associated with the private IP addresses. - * `private_ips_link_public_ip_public_ips` - (Optional) The EIPs associated with the private IP addresses. - * `private_ips_primary_ip` - (Optional) The primary private IP addresses of the NICs. + * `private_ips_link_public_ip_account_ids` - (Optional) The account IDs of the owner of the public IPs associated with the private IP addresses. + * `private_ips_link_public_ip_public_ips` - (Optional) The public IPs associated with the private IP addresses. + * `private_ips_primary_ip` - (Optional) Whether the private IP address is the primary IP address associated with the NIC. * `private_ips_private_ips` - (Optional) The private IP addresses of the NICs. * `security_group_ids` - (Optional) The IDs of the security groups associated with the NICs. * `security_group_names` - (Optional) The names of the security groups associated with the NICs. @@ -72,24 +72,24 @@ The following attributes are exported: * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). * `vm_account_id` - The account ID of the owner of the VM. * `vm_id` - The ID of the VM. - * `link_public_ip` - Information about the EIP association. - * `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. + * `link_public_ip` - Information about the public IP association. + * `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. - * `public_ip_id` - The allocation ID of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. + * `public_ip_id` - The allocation ID of the public IP. * `mac_address` - The Media Access Control (MAC) address of the NIC. * `net_id` - The ID of the Net for the NIC. * `nic_id` - The ID of the NIC. * `private_dns_name` - The name of the private DNS. * `private_ips` - The private IP addresses of the NIC. * `is_primary` - If true, the IP address is the primary private IP address of the NIC. - * `link_public_ip` - Information about the EIP association. - * `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. + * `link_public_ip` - Information about the public IP association. + * `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. - * `public_ip_id` - The allocation ID of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. + * `public_ip_id` - The allocation ID of the public IP. * `private_dns_name` - The name of the private DNS. * `private_ip` - The private IP address of the NIC. * `security_groups` - One or more IDs of security groups for the NIC. diff --git a/website/docs/d/product_type.html.markdown b/website/docs/d/product_type.html.markdown index 0ac23ee49..659ca26b9 100644 --- a/website/docs/d/product_type.html.markdown +++ b/website/docs/d/product_type.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_product_type Data Source Provides information about a specific product type. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/Software+Licenses). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/Software-Licenses.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-producttype). ## Example Usage diff --git a/website/docs/d/product_types.html.markdown b/website/docs/d/product_types.html.markdown index fcb7c799f..ba6cf807c 100644 --- a/website/docs/d/product_types.html.markdown +++ b/website/docs/d/product_types.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_product_types Data Source Provides information about product types. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/Software+Licenses). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/Software-Licenses.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-producttype). ## Example Usage diff --git a/website/docs/d/public_ip.html.markdown b/website/docs/d/public_ip.html.markdown index 70b83793b..ce718eb50 100644 --- a/website/docs/d/public_ip.html.markdown +++ b/website/docs/d/public_ip.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_public_ip Data Source Provides information about a specific public IP. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+EIPs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-EIPs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-publicip). ## Example Usage @@ -28,29 +28,29 @@ data "outscale_public_ip" "public_ip01" { The following arguments are supported: * `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following: - * `link_public_ip_ids` - (Optional) The IDs representing the associations of EIPs with VMs or NICs. + * `link_public_ip_ids` - (Optional) The IDs representing the associations of public IPs with VMs or NICs. * `nic_account_ids` - (Optional) The account IDs of the owners of the NICs. * `nic_ids` - (Optional) The IDs of the NICs. - * `placements` - (Optional) Whether the EIPs are for use in the public Cloud or in a Net. - * `private_ips` - (Optional) The private IP addresses associated with the EIPs. - * `public_ip_ids` - (Optional) The IDs of the External IP addresses (EIPs). - * `public_ips` - (Optional) The External IP addresses (EIPs). - * `tag_keys` - (Optional) The keys of the tags associated with the EIPs. - * `tag_values` - (Optional) The values of the tags associated with the EIPs. - * `tags` - (Optional) The key/value combination of the tags associated with the EIPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}. + * `placements` - (Optional) Whether the public IPs are for use in the public Cloud or in a Net. + * `private_ips` - (Optional) The private IP addresses associated with the public IPs. + * `public_ip_ids` - (Optional) The IDs of the public IPs. + * `public_ips` - (Optional) The public IPs. + * `tag_keys` - (Optional) The keys of the tags associated with the public IPs. + * `tag_values` - (Optional) The values of the tags associated with the public IPs. + * `tags` - (Optional) The key/value combination of the tags associated with the public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}. * `vm_ids` - (Optional) The IDs of the VMs. ## Attribute Reference The following attributes are exported: -* `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. +* `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `nic_account_id` - The account ID of the owner of the NIC. -* `nic_id` - The ID of the NIC the EIP is associated with (if any). -* `private_ip` - The private IP address associated with the EIP. -* `public_ip_id` - The allocation ID of the EIP associated with the NAT service. -* `public_ip` - The External IP address (EIP) associated with the NAT service. -* `tags` - One or more tags associated with the EIP. +* `nic_id` - The ID of the NIC the public IP is associated with (if any). +* `private_ip` - The private IP address associated with the public IP. +* `public_ip_id` - The allocation ID of the public IP. +* `public_ip` - The public IP. +* `tags` - One or more tags associated with the public IP. * `key` - The key of the tag, with a minimum of 1 character. * `value` - The value of the tag, between 0 and 255 characters. -* `vm_id` - The ID of the VM the External IP (EIP) is associated with (if any). +* `vm_id` - The ID of the VM the public IP is associated with (if any). diff --git a/website/docs/d/public_ips.html.markdown b/website/docs/d/public_ips.html.markdown index 2e3f94360..7f6c65ce6 100644 --- a/website/docs/d/public_ips.html.markdown +++ b/website/docs/d/public_ips.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_public_ips Data Source Provides information about public IPs. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+EIPs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-EIPs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-publicip). ## Example Usage @@ -28,30 +28,30 @@ data "outscale_public_ips" "public_ips01" { The following arguments are supported: * `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following: - * `link_public_ip_ids` - (Optional) The IDs representing the associations of EIPs with VMs or NICs. + * `link_public_ip_ids` - (Optional) The IDs representing the associations of public IPs with VMs or NICs. * `nic_account_ids` - (Optional) The account IDs of the owners of the NICs. * `nic_ids` - (Optional) The IDs of the NICs. - * `placements` - (Optional) Whether the EIPs are for use in the public Cloud or in a Net. - * `private_ips` - (Optional) The private IP addresses associated with the EIPs. - * `public_ip_ids` - (Optional) The IDs of the External IP addresses (EIPs). - * `public_ips` - (Optional) The External IP addresses (EIPs). - * `tag_keys` - (Optional) The keys of the tags associated with the EIPs. - * `tag_values` - (Optional) The values of the tags associated with the EIPs. - * `tags` - (Optional) The key/value combination of the tags associated with the EIPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}. + * `placements` - (Optional) Whether the public IPs are for use in the public Cloud or in a Net. + * `private_ips` - (Optional) The private IP addresses associated with the public IPs. + * `public_ip_ids` - (Optional) The IDs of the public IPs. + * `public_ips` - (Optional) The public IPs. + * `tag_keys` - (Optional) The keys of the tags associated with the public IPs. + * `tag_values` - (Optional) The values of the tags associated with the public IPs. + * `tags` - (Optional) The key/value combination of the tags associated with the public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}. * `vm_ids` - (Optional) The IDs of the VMs. ## Attribute Reference The following attributes are exported: -* `public_ips` - Information about one or more EIPs. - * `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. +* `public_ips` - Information about one or more public IPs. + * `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `nic_account_id` - The account ID of the owner of the NIC. - * `nic_id` - The ID of the NIC the EIP is associated with (if any). - * `private_ip` - The private IP address associated with the EIP. - * `public_ip` - The External IP address (EIP) associated with the NAT service. - * `public_ip_id` - The allocation ID of the EIP associated with the NAT service. - * `tags` - One or more tags associated with the EIP. + * `nic_id` - The ID of the NIC the public IP is associated with (if any). + * `private_ip` - The private IP address associated with the public IP. + * `public_ip` - The public IP. + * `public_ip_id` - The allocation ID of the public IP. + * `tags` - One or more tags associated with the public IP. * `key` - The key of the tag, with a minimum of 1 character. * `value` - The value of the tag, between 0 and 255 characters. - * `vm_id` - The ID of the VM the External IP (EIP) is associated with (if any). + * `vm_id` - The ID of the VM the public IP is associated with (if any). diff --git a/website/docs/d/quota.html.markdown b/website/docs/d/quota.html.markdown index 545afd25e..d9bc3b0c2 100644 --- a/website/docs/d/quota.html.markdown +++ b/website/docs/d/quota.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_quota Data Source Provides information about a specific quota. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Your+Account). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Your-Account.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readquotas). ## Example Usage diff --git a/website/docs/d/quotas.html.markdown b/website/docs/d/quotas.html.markdown index a4604f68d..840b70a11 100644 --- a/website/docs/d/quotas.html.markdown +++ b/website/docs/d/quotas.html.markdown @@ -3,13 +3,13 @@ layout: "outscale" page_title: "OUTSCALE: outscale_quotas" sidebar_current: "outscale-quotas" description: |- - [Provides information about quotas.] + [Provides information about a specific quotas.] --- # outscale_quotas Data Source -Provides information about quotas. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Your+Account). +Provides information about a specific quotas. +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Your-Account.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readquotas). ## Example Usage diff --git a/website/docs/d/regions.html.markdown b/website/docs/d/regions.html.markdown index 355150a37..df97bc884 100644 --- a/website/docs/d/regions.html.markdown +++ b/website/docs/d/regions.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_regions Data Source Provides information about Regions. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Regions%2C+Endpoints%2C+and+Availability+Zones). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Availability-Zones.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readregions). ## Example Usage diff --git a/website/docs/d/route_table.html.markdown b/website/docs/d/route_table.html.markdown index fada68718..4aedc68fb 100644 --- a/website/docs/d/route_table.html.markdown +++ b/website/docs/d/route_table.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_route_table Data Source Provides information about a specific route table. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Route+Tables). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Route-Tables.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-routetable). ## Example Usage diff --git a/website/docs/d/route_tables.html.markdown b/website/docs/d/route_tables.html.markdown index 23e68fe12..66dfdd291 100644 --- a/website/docs/d/route_tables.html.markdown +++ b/website/docs/d/route_tables.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_route_tables Data Source Provides information about route tables. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Route+Tables). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Route-Tables.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-routetable). ## Example Usage diff --git a/website/docs/d/security_group.html.markdown b/website/docs/d/security_group.html.markdown index 4f27b59b4..08908719b 100644 --- a/website/docs/d/security_group.html.markdown +++ b/website/docs/d/security_group.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_security_group Data Source Provides information about a specific security group. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Security+Groups). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Security-Groups.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-securitygroup). ## Example Usage diff --git a/website/docs/d/security_groups.html.markdown b/website/docs/d/security_groups.html.markdown index d4e3454e2..b83f1086f 100644 --- a/website/docs/d/security_groups.html.markdown +++ b/website/docs/d/security_groups.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_security_groups Data Source Provides information about security groups. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Security+Groups). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Security-Groups.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-securitygroup). ## Example Usage diff --git a/website/docs/d/server_certificate.html.markdown b/website/docs/d/server_certificate.html.markdown index 58fc4a3fb..cb188ac0f 100644 --- a/website/docs/d/server_certificate.html.markdown +++ b/website/docs/d/server_certificate.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_server_certificate Data Source Provides information about a specific server certificate. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Server+Certificates+in+EIM). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-servercertificate). ## Example Usage diff --git a/website/docs/d/server_certificates.html.markdown b/website/docs/d/server_certificates.html.markdown index e83c2219f..80725fade 100644 --- a/website/docs/d/server_certificates.html.markdown +++ b/website/docs/d/server_certificates.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_server_certificates Data Source Provides information about server certificates. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Server+Certificates+in+EIM). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-servercertificate). ## Example Usage diff --git a/website/docs/d/snapshot.html.markdown b/website/docs/d/snapshot.html.markdown index 6d23e20d6..1248f54b1 100644 --- a/website/docs/d/snapshot.html.markdown +++ b/website/docs/d/snapshot.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_snapshot Data Source Provides information about a specific snapshot. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Snapshots). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Snapshots.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-snapshot). ## Example Usage diff --git a/website/docs/d/snapshot_export_task.html.markdown b/website/docs/d/snapshot_export_task.html.markdown index efe30c463..1ca134ff8 100644 --- a/website/docs/d/snapshot_export_task.html.markdown +++ b/website/docs/d/snapshot_export_task.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_snapshot_export_task Data Source Provides information about a specific snapshot export task. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Snapshots). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Snapshots.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-snapshot). ## Example Usage diff --git a/website/docs/d/snapshot_export_tasks.html.markdown b/website/docs/d/snapshot_export_tasks.html.markdown index eab0a16f7..cbaa519fd 100644 --- a/website/docs/d/snapshot_export_tasks.html.markdown +++ b/website/docs/d/snapshot_export_tasks.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_snapshot_export_tasks Data Source Provides information about snapshot export tasks. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Snapshots). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Snapshots.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-snapshot). ## Example Usage diff --git a/website/docs/d/snapshots.html.markdown b/website/docs/d/snapshots.html.markdown index ab218b320..176641436 100644 --- a/website/docs/d/snapshots.html.markdown +++ b/website/docs/d/snapshots.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_snapshots Data Source Provides information about snapshots. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Snapshots). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Snapshots.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-snapshot). ## Example Usage diff --git a/website/docs/d/subnet.html.markdown b/website/docs/d/subnet.html.markdown index f50dc8b7f..8b9085763 100644 --- a/website/docs/d/subnet.html.markdown +++ b/website/docs/d/subnet.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_subnet Data Source Provides information about a specific Subnet. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPCs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPCs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-subnet). ## Example Usage @@ -44,7 +44,7 @@ The following attributes are exported: * `available_ips_count` - The number of available IP addresses in the Subnets. * `ip_range` - The IP range in the Subnet, in CIDR notation (for example, 10.0.0.0/16). -* `map_public_ip_on_launch` - If true, a public IP address is assigned to the network interface cards (NICs) created in the specified Subnet. +* `map_public_ip_on_launch` - If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. * `net_id` - The ID of the Net in which the Subnet is. * `state` - The state of the Subnet (`pending` \| `available`). * `subnet_id` - The ID of the Subnet. diff --git a/website/docs/d/subnets.html.markdown b/website/docs/d/subnets.html.markdown index cc415858e..b633bad68 100644 --- a/website/docs/d/subnets.html.markdown +++ b/website/docs/d/subnets.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_subnets Data Source Provides information about Subnets. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPCs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPCs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-subnet). ## Example Usage @@ -45,7 +45,7 @@ The following attributes are exported: * `subnets` - Information about one or more Subnets. * `available_ips_count` - The number of available IP addresses in the Subnets. * `ip_range` - The IP range in the Subnet, in CIDR notation (for example, 10.0.0.0/16). - * `map_public_ip_on_launch` - If true, a public IP address is assigned to the network interface cards (NICs) created in the specified Subnet. + * `map_public_ip_on_launch` - If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. * `net_id` - The ID of the Net in which the Subnet is. * `state` - The state of the Subnet (`pending` \| `available`). * `subnet_id` - The ID of the Subnet. diff --git a/website/docs/d/subregions.html.markdown b/website/docs/d/subregions.html.markdown index 41245bc79..be52e8cd7 100644 --- a/website/docs/d/subregions.html.markdown +++ b/website/docs/d/subregions.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_subregions Data Source Provides information about subregions. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Regions%2C+Endpoints%2C+and+Availability+Zones). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Regions-Endpoints-and-Availability-Zones.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readsubregions). ## Example Usage diff --git a/website/docs/d/virtual_gateway.html.markdown b/website/docs/d/virtual_gateway.html.markdown index 96ebb737b..807f17359 100644 --- a/website/docs/d/virtual_gateway.html.markdown +++ b/website/docs/d/virtual_gateway.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_virtual_gateway Data Source Provides information about a specific virtual gateway. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Virtual+Private+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Virtual-Private-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-virtualgateway). ## Example Usage diff --git a/website/docs/d/virtual_gateways.html.markdown b/website/docs/d/virtual_gateways.html.markdown index 810005d83..1825c4c3c 100644 --- a/website/docs/d/virtual_gateways.html.markdown +++ b/website/docs/d/virtual_gateways.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_virtual_gateways Data Source Provides information about virtual gateways. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Virtual+Private+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Virtual-Private-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-virtualgateway). ## Example Usage diff --git a/website/docs/d/vm.html.markdown b/website/docs/d/vm.html.markdown index 4103a4775..b73dfc337 100644 --- a/website/docs/d/vm.html.markdown +++ b/website/docs/d/vm.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vm Data Source Provides information about a specific virtual machine (VM). -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Instances). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Instances.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-vm). ## Example Usage @@ -63,20 +63,20 @@ The following attributes are exported: * `device_number` - The device index for the NIC attachment (between 1 and 7, both included). * `link_nic_id` - The ID of the NIC to attach. * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). - * `link_public_ip` - Information about the EIP associated with the NIC. + * `link_public_ip` - Information about the public IP associated with the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. * `mac_address` - The Media Access Control (MAC) address of the NIC. * `net_id` - The ID of the Net for the NIC. * `nic_id` - The ID of the NIC. * `private_dns_name` - The name of the private DNS. * `private_ips` - The private IP address or addresses of the NIC. * `is_primary` - If true, the IP address is the primary private IP address of the NIC. - * `link_public_ip` - Information about the EIP associated with the NIC. + * `link_public_ip` - Information about the public IP associated with the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. * `private_dns_name` - The name of the private DNS. * `private_ip` - The private IP address. * `security_groups` - One or more IDs of security groups for the NIC. @@ -93,7 +93,7 @@ The following attributes are exported: * `private_ip` - The primary private IP address of the VM. * `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10). * `public_dns_name` - The name of the public DNS. -* `public_ip` - The public IP address of the VM. +* `public_ip` - The public IP of the VM. * `reservation_id` - The reservation ID of the VM. * `root_device_name` - The name of the root device for the VM (for example, /dev/vda1). * `root_device_type` - The type of root device used by the VM (always `bsu`). diff --git a/website/docs/d/vm_state.html.markdown b/website/docs/d/vm_state.html.markdown index f1aacac84..d47259a2d 100644 --- a/website/docs/d/vm_state.html.markdown +++ b/website/docs/d/vm_state.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vm_state Data Source Provides information about a specific VM state. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Instance+Lifecycle). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Instance-Lifecycle.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readvmsstate). ## Example Usage @@ -29,7 +29,7 @@ The following arguments are supported: * `all_vms` - (Optional) If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs. * `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following: - * `maintenance_event_codes` - (Optional) The code for the scheduled event (`system-reboot` | `system-maintenance`). + * `maintenance_event_codes` - (Optional) The code for the scheduled event (`system-reboot` \| `system-maintenance`). * `maintenance_event_descriptions` - (Optional) The description of the scheduled event. * `maintenance_events_not_after` - (Optional) The latest time the event can end. * `maintenance_events_not_before` - (Optional) The earliest time the event can start. diff --git a/website/docs/d/vm_states.html.markdown b/website/docs/d/vm_states.html.markdown index b2b137017..aa4da6f30 100644 --- a/website/docs/d/vm_states.html.markdown +++ b/website/docs/d/vm_states.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vm_states Data Source Provides information about VM states. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Instance+Lifecycle). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Instance-Lifecycle.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readvmsstate). ## Example Usage @@ -30,7 +30,7 @@ The following arguments are supported: * `all_vms` - (Optional) If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs. * `filter` - (Optional) A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following: - * `maintenance_event_codes` - (Optional) The code for the scheduled event (`system-reboot` | `system-maintenance`). + * `maintenance_event_codes` - (Optional) The code for the scheduled event (`system-reboot` \| `system-maintenance`). * `maintenance_event_descriptions` - (Optional) The description of the scheduled event. * `maintenance_events_not_after` - (Optional) The latest time the event can end. * `maintenance_events_not_before` - (Optional) The earliest time the event can start. diff --git a/website/docs/d/vm_types.html.markdown b/website/docs/d/vm_types.html.markdown index ba4180f74..3ae38da31 100644 --- a/website/docs/d/vm_types.html.markdown +++ b/website/docs/d/vm_types.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vm_types Data Source Provides information about VM types. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/Instance+Types). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/Instance-Types.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#readvmtypes). ## Example Usage diff --git a/website/docs/d/vms.html.markdown b/website/docs/d/vms.html.markdown index 4ba4e851b..cc8fb5ab5 100644 --- a/website/docs/d/vms.html.markdown +++ b/website/docs/d/vms.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vms Data Source Provides information about virtual machines (VMs). -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Instances). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Instances.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-vm). ## Example Usage @@ -64,20 +64,20 @@ The following attributes are exported: * `device_number` - The device index for the NIC attachment (between 1 and 7, both included). * `link_nic_id` - The ID of the NIC to attach. * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). - * `link_public_ip` - Information about the EIP associated with the NIC. + * `link_public_ip` - Information about the public IP associated with the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. * `mac_address` - The Media Access Control (MAC) address of the NIC. * `net_id` - The ID of the Net for the NIC. * `nic_id` - The ID of the NIC. * `private_dns_name` - The name of the private DNS. * `private_ips` - The private IP address or addresses of the NIC. * `is_primary` - If true, the IP address is the primary private IP address of the NIC. - * `link_public_ip` - Information about the EIP associated with the NIC. + * `link_public_ip` - Information about the public IP associated with the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. * `private_dns_name` - The name of the private DNS. * `private_ip` - The private IP address. * `security_groups` - One or more IDs of security groups for the NIC. @@ -94,7 +94,7 @@ The following attributes are exported: * `private_ip` - The primary private IP address of the VM. * `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10). * `public_dns_name` - The name of the public DNS. - * `public_ip` - The public IP address of the VM. + * `public_ip` - The public IP of the VM. * `reservation_id` - The reservation ID of the VM. * `root_device_name` - The name of the root device for the VM (for example, /dev/vda1). * `root_device_type` - The type of root device used by the VM (always `bsu`). diff --git a/website/docs/d/volume.html.markdown b/website/docs/d/volume.html.markdown index 477efcac1..07a90ae77 100644 --- a/website/docs/d/volume.html.markdown +++ b/website/docs/d/volume.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_volume Data Source Provides information about a specific volume. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Volumes). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Volumes.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-volume). ## Example Usage diff --git a/website/docs/d/volumes.html.markdown b/website/docs/d/volumes.html.markdown index 907a81896..09f5ad47b 100644 --- a/website/docs/d/volumes.html.markdown +++ b/website/docs/d/volumes.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_volumes Data Source Provides information about volumes. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Volumes). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Volumes.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-volume). ## Example Usage diff --git a/website/docs/d/vpn_connection.html.markdown b/website/docs/d/vpn_connection.html.markdown index a03d44da7..1c5cfc18d 100644 --- a/website/docs/d/vpn_connection.html.markdown +++ b/website/docs/d/vpn_connection.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vpn_connection Data Source Provides information about a specific VPN connection. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPN+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-vpnconnection). ## Example Usage diff --git a/website/docs/d/vpn_connections.html.markdown b/website/docs/d/vpn_connections.html.markdown index cf8674651..238aac614 100644 --- a/website/docs/d/vpn_connections.html.markdown +++ b/website/docs/d/vpn_connections.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vpn_connections Data Source Provides information about VPN connections. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPN+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-vpnconnection). ## Example Usage diff --git a/website/docs/r/access_key.html.markdown b/website/docs/r/access_key.html.markdown index ed19e599f..5541594e7 100644 --- a/website/docs/r/access_key.html.markdown +++ b/website/docs/r/access_key.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_access_key Resource Manages an access key. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Access+Keys). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Access-Keys.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-accesskey). ## Example Usage @@ -22,7 +22,7 @@ resource "outscale_access_key" "access_key01" { ## Argument Reference -The following argument is supported: +The following arguments are supported: * `state` - (Optional) The state for the access key (`ACTIVE` | `INACTIVE`). diff --git a/website/docs/r/client_gateway.html.markdown b/website/docs/r/client_gateway.html.markdown index 02e46b668..dc8eb125e 100644 --- a/website/docs/r/client_gateway.html.markdown +++ b/website/docs/r/client_gateway.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_client_gateway Resource Manages a client gateway. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Customer+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Customer-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-clientgateway). ## Example Usage diff --git a/website/docs/r/dhcp_option.html.markdown b/website/docs/r/dhcp_option.html.markdown index 50b1554ef..e0da157d6 100644 --- a/website/docs/r/dhcp_option.html.markdown +++ b/website/docs/r/dhcp_option.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_dhcp_option Resource Manages a DHCP option. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+DHCP+Options). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-dhcpoption). ## Example Usage diff --git a/website/docs/r/flexible_gpu.html.markdown b/website/docs/r/flexible_gpu.html.markdown index 8146f04f8..53ddf2baf 100644 --- a/website/docs/r/flexible_gpu.html.markdown +++ b/website/docs/r/flexible_gpu.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_flexible_gpu Resource Manages a flexible GPU. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Flexible+GPUs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-flexiblegpu). ## Example Usage diff --git a/website/docs/r/flexible_gpu_link.html.markdown b/website/docs/r/flexible_gpu_link.html.markdown index ae0bf3c94..18928b431 100644 --- a/website/docs/r/flexible_gpu_link.html.markdown +++ b/website/docs/r/flexible_gpu_link.html.markdown @@ -8,8 +8,8 @@ description: |- # outscale_flexible_gpu_link Resource -Manages a flexible GPU link. When linking a flexible GPU to a VM, the VM will automatically be stopped and started again. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Flexible+GPUs). +Manages a flexible GPU link. +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-flexiblegpu). ## Example Usage diff --git a/website/docs/r/image.html.markdown b/website/docs/r/image.html.markdown index 0303f2fb9..bd12a3f48 100644 --- a/website/docs/r/image.html.markdown +++ b/website/docs/r/image.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_image Resource Manages an image. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+OMIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-OMIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-image). ## Example Usage diff --git a/website/docs/r/image_export_task.html.markdown b/website/docs/r/image_export_task.html.markdown index cfa50c745..3df7de144 100644 --- a/website/docs/r/image_export_task.html.markdown +++ b/website/docs/r/image_export_task.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_image_export_task Resource Manages an image export task. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+OMIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-OMIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-image). ## Example Usage diff --git a/website/docs/r/image_launch_permission.html.markdown b/website/docs/r/image_launch_permission.html.markdown index a47b64fee..dcfe6a075 100644 --- a/website/docs/r/image_launch_permission.html.markdown +++ b/website/docs/r/image_launch_permission.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_image_launch_permission Resource Manages an image launch permission. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+OMIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-OMIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#updateimage). ## Example Usage diff --git a/website/docs/r/internet_service.html.markdown b/website/docs/r/internet_service.html.markdown index e39d98aa1..d93dd2b84 100644 --- a/website/docs/r/internet_service.html.markdown +++ b/website/docs/r/internet_service.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_internet_service Resource Manages an Internet service. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Internet+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Internet-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-internetservice). ## Example Usage @@ -33,7 +33,7 @@ The following attributes are exported: * `internet_service_id` - The ID of the Internet service. * `net_id` - The ID of the Net attached to the Internet service. -* `state` - The state of the attachment of the Net to the Internet service (always `available`). +* `state` - The state of the attachment of the Internet service to the Net (always `available`). * `tags` - One or more tags associated with the Internet service. * `key` - The key of the tag, with a minimum of 1 character. * `value` - The value of the tag, between 0 and 255 characters. diff --git a/website/docs/r/internet_service_link.html.markdown b/website/docs/r/internet_service_link.html.markdown index 33c59ca06..b9ca8118e 100644 --- a/website/docs/r/internet_service_link.html.markdown +++ b/website/docs/r/internet_service_link.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_internet_service_link Resource Manages an Internet service link. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Internet+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Internet-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-internetservice). ## Example Usage diff --git a/website/docs/r/keypair.html.markdown b/website/docs/r/keypair.html.markdown index 33c091d35..f7b5f18ad 100644 --- a/website/docs/r/keypair.html.markdown +++ b/website/docs/r/keypair.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_keypair Resource Manages a keypair. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Keypairs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Keypairs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-keypair). ## Example Usage @@ -49,7 +49,7 @@ The following attributes are exported: * `keypair_fingerprint` - The MD5 public key fingerprint as specified in section 4 of RFC 4716. * `keypair_name` - The name of the keypair. -* `private_key` - The private key. +* `private_key` - The private key. When saving the private key in a .rsa file, replace the `\n` escape sequences with line breaks. ## Import diff --git a/website/docs/r/load_balancer.html.markdown b/website/docs/r/load_balancer.html.markdown index c94389838..80a63aa0b 100644 --- a/website/docs/r/load_balancer.html.markdown +++ b/website/docs/r/load_balancer.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer Resource Manages a load balancer. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-loadbalancer). ## Example Usage @@ -169,7 +169,7 @@ The following arguments are supported: The following attributes are exported: * `access_log` - Information about access logs. - * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `osu_bucket_name` parameter is required. + * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. * `osu_bucket_name` - The name of the OOS bucket for the access logs. * `osu_bucket_prefix` - The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). * `publication_interval` - The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either 5 or 60 (by default, 60). @@ -197,7 +197,7 @@ The following attributes are exported: * `load_balancer_sticky_cookie_policies` - The policies defined for the load balancer. * `policy_name` - The name of the stickiness policy. * `load_balancer_type` - The type of load balancer. Valid only for load balancers in a Net.
-If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP address.
+If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.
If `LoadBalancerType` is `internal`, the load balancer has a public DNS name that resolves to a private IP address. * `net_id` - The ID of the Net for the load balancer. * `security_groups` - One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net. diff --git a/website/docs/r/load_balancer_attributes.html.markdown b/website/docs/r/load_balancer_attributes.html.markdown index f2baec8e1..6c448d950 100644 --- a/website/docs/r/load_balancer_attributes.html.markdown +++ b/website/docs/r/load_balancer_attributes.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer_attributes Resource Manages load balancer attributes. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#updateloadbalancer). ## Example Usage @@ -106,7 +106,7 @@ resource "outscale_load_balancer_attributes" "attributes04" { The following arguments are supported: * `access_log` - Information about access logs. - * `is_enabled` - (Optional) If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `osu_bucket_name` parameter is required. + * `is_enabled` - (Optional) If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. * `osu_bucket_name` - (Optional) The name of the OOS bucket for the access logs. * `osu_bucket_prefix` - (Optional) The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). * `publication_interval` - (Optional) The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either 5 or 60 (by default, 60). @@ -121,14 +121,14 @@ The following arguments are supported: * `load_balancer_name` - (Required) The name of the load balancer. * `load_balancer_port` - (Optional) The port on which the load balancer is listening (between `1` and `65535`, both included). This parameter is required if you want to update the server certificate. * `policy_names` - (Optional) The name of the policy you want to enable for the listener. -* `server_certificate_id` - (Optional) The Outscale Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > Outscale Resource Names (ORNs)](https://wiki.outscale.net/display/EN/Resource+Identifiers#ResourceIdentifiers-ORNFormat). If this parameter is specified, you must also specify the `load_balancer_port` parameter. +* `server_certificate_id` - (Optional) The Outscale Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > Outscale Resource Names (ORNs)](https://wiki.outscale.net/display/EN/Resource+Identifiers#ResourceIdentifiers-ORNFormat). If this parameter is specified, you must also specify the `LoadBalancerPort` parameter. ## Attribute Reference The following attributes are exported: * `access_log` - Information about access logs. - * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `osu_bucket_name` parameter is required. + * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. * `osu_bucket_name` - The name of the OOS bucket for the access logs. * `osu_bucket_prefix` - The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). * `publication_interval` - The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either 5 or 60 (by default, 60). @@ -156,8 +156,8 @@ The following attributes are exported: * `load_balancer_sticky_cookie_policies` - The policies defined for the load balancer. * `policy_name` - The name of the stickiness policy. * `load_balancer_type` - The type of load balancer. Valid only for load balancers in a Net.
-If `load_balancer_type` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP address.
-If `load_balancer_type` is `internal`, the load balancer has a public DNS name that resolves to a private IP address. +If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.
+If `LoadBalancerType` is `internal`, the load balancer has a public DNS name that resolves to a private IP address. * `net_id` - The ID of the Net for the load balancer. * `security_groups` - One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net. * `source_security_group` - Information about the source security group of the load balancer, which you can use as part of your inbound rules for your registered VMs.
diff --git a/website/docs/r/load_balancer_listener_rule.html.markdown b/website/docs/r/load_balancer_listener_rule.html.markdown index d257b6755..c525b21db 100644 --- a/website/docs/r/load_balancer_listener_rule.html.markdown +++ b/website/docs/r/load_balancer_listener_rule.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer_listener_rule Resource Manages a load balancer listener rule. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-listener). ## Example Usage diff --git a/website/docs/r/load_balancer_policy.html.markdown b/website/docs/r/load_balancer_policy.html.markdown index 857b61655..833ff7401 100644 --- a/website/docs/r/load_balancer_policy.html.markdown +++ b/website/docs/r/load_balancer_policy.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer_policy Resource Manages a load balancer policy. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-loadbalancerpolicy). ## Example Usage @@ -72,7 +72,7 @@ The following arguments are supported: The following attributes are exported: * `access_log` - Information about access logs. - * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `osu_bucket_name` parameter is required. + * `is_enabled` - If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required. * `osu_bucket_name` - The name of the OOS bucket for the access logs. * `osu_bucket_prefix` - The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket). * `publication_interval` - The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either 5 or 60 (by default, 60). @@ -100,7 +100,7 @@ The following attributes are exported: * `load_balancer_sticky_cookie_policies` - The policies defined for the load balancer. * `policy_name` - The name of the stickiness policy. * `load_balancer_type` - The type of load balancer. Valid only for load balancers in a Net.
-If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP address.
+If `LoadBalancerType` is `internet-facing`, the load balancer has a public DNS name that resolves to a public IP.
If `LoadBalancerType` is `internal`, the load balancer has a public DNS name that resolves to a private IP address. * `net_id` - The ID of the Net for the load balancer. * `security_groups` - One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net. diff --git a/website/docs/r/load_balancer_vms.html.markdown b/website/docs/r/load_balancer_vms.html.markdown index ade23aafe..787266595 100644 --- a/website/docs/r/load_balancer_vms.html.markdown +++ b/website/docs/r/load_balancer_vms.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_load_balancer_vms Resource Manages load balancer VMs. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Load+Balancers). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Load-Balancers.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-loadbalancer). ## Example Usage diff --git a/website/docs/r/nat_service.html.markdown b/website/docs/r/nat_service.html.markdown index efd14b112..0db8a49c2 100644 --- a/website/docs/r/nat_service.html.markdown +++ b/website/docs/r/nat_service.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nat_service Resource Manages a NAT service. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+NAT+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-NAT-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-natservice). ## Example Usage @@ -68,8 +68,8 @@ resource "outscale_nat_service" "nat_service01" { The following arguments are supported: -* `public_ip_id` - (Required) The allocation ID of the EIP to associate with the NAT service.
-If the EIP is already associated with another resource, you must first disassociate it. +* `public_ip_id` - (Required) The allocation ID of the public IP to associate with the NAT service.
+If the public IP is already associated with another resource, you must first disassociate it. * `subnet_id` - (Required) The ID of the Subnet in which you want to create the NAT service. * `tags` - (Optional) A tag to add to this resource. You can specify this argument several times. * `key` - (Required) The key of the tag, with a minimum of 1 character. @@ -81,9 +81,9 @@ The following attributes are exported: * `nat_service_id` - The ID of the NAT service. * `net_id` - The ID of the Net in which the NAT service is. -* `public_ips` - Information about the External IP address or addresses (EIPs) associated with the NAT service. - * `public_ip` - The External IP address (EIP) associated with the NAT service. - * `public_ip_id` - The allocation ID of the EIP associated with the NAT service. +* `public_ips` - Information about the public IP or IPs associated with the NAT service. + * `public_ip` - The public IP associated with the NAT service. + * `public_ip_id` - The allocation ID of the public IP associated with the NAT service. * `state` - The state of the NAT service (`pending` \| `available` \| `deleting` \| `deleted`). * `subnet_id` - The ID of the Subnet in which the NAT service is. * `tags` - One or more tags associated with the NAT service. diff --git a/website/docs/r/net.html.markdown b/website/docs/r/net.html.markdown index 66a11b42a..c9e34b8ec 100644 --- a/website/docs/r/net.html.markdown +++ b/website/docs/r/net.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net Resource Manages a Net. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPCs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPCs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-net). ## Example Usage diff --git a/website/docs/r/net_access_point.html.markdown b/website/docs/r/net_access_point.html.markdown index cf2da70e7..a8d7b4ffb 100644 --- a/website/docs/r/net_access_point.html.markdown +++ b/website/docs/r/net_access_point.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_access_point Resource Manages a Net access point. -For more information on this resource, see the [User Guide](https://wiki.outscale.internal/display/EN/About+VPC+Endpoints). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Endpoints.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netaccesspoint). ## Example Usage diff --git a/website/docs/r/net_attributes.html.markdown b/website/docs/r/net_attributes.html.markdown index 3d5a51e7d..ca6544350 100644 --- a/website/docs/r/net_attributes.html.markdown +++ b/website/docs/r/net_attributes.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_attributes Resource Manages Net attributes. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+DHCP+Options). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-DHCP-Options.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#updatenet). ## Example Usage diff --git a/website/docs/r/net_peering.html.markdown b/website/docs/r/net_peering.html.markdown index b23e169cc..9c4ac0820 100644 --- a/website/docs/r/net_peering.html.markdown +++ b/website/docs/r/net_peering.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_peering Resource Manages a Net peering. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPC+Peering+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Peering-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netpeering). ## Example Usage diff --git a/website/docs/r/net_peering_acceptation.html.markdown b/website/docs/r/net_peering_acceptation.html.markdown index 7f6c8ff90..6ee298ad6 100644 --- a/website/docs/r/net_peering_acceptation.html.markdown +++ b/website/docs/r/net_peering_acceptation.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_net_peering_acceptation Resource Manages a Net peering acceptation. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPC+Peering+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPC-Peering-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-netpeering). ## Example Usage diff --git a/website/docs/r/nic.html.markdown b/website/docs/r/nic.html.markdown index 6c3dd247e..21b1c6bee 100644 --- a/website/docs/r/nic.html.markdown +++ b/website/docs/r/nic.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nic Resource Manages a network interface card (NIC). -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+FNIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-FNIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-nic). ## Example Usage @@ -67,7 +67,7 @@ The following arguments are supported: * `description` - (Optional) A description for the NIC. * `private_ips` - (Optional) The primary private IP address for the NIC.
-This IP address must be within the IP address range of the Subnet that you specify with the `subnet_id` attribute.
+This IP address must be within the IP address range of the Subnet that you specify with the `SubnetId` attribute.
If you do not specify this attribute, a random private IP address is selected within the IP address range of the Subnet. * `is_primary` - (Optional) If true, the IP address is the primary private IP address of the NIC. * `private_ip` - (Optional) The private IP address of the NIC. @@ -91,24 +91,24 @@ The following attributes are exported: * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). * `vm_account_id` - The account ID of the owner of the VM. * `vm_id` - The ID of the VM. -* `link_public_ip` - Information about the EIP association. - * `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. +* `link_public_ip` - Information about the public IP association. + * `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. - * `public_ip_id` - The allocation ID of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. + * `public_ip_id` - The allocation ID of the public IP. * `mac_address` - The Media Access Control (MAC) address of the NIC. * `net_id` - The ID of the Net for the NIC. * `nic_id` - The ID of the NIC. * `private_dns_name` - The name of the private DNS. * `private_ips` - The private IP addresses of the NIC. * `is_primary` - If true, the IP address is the primary private IP address of the NIC. - * `link_public_ip` - Information about the EIP association. - * `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. + * `link_public_ip` - Information about the public IP association. + * `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. - * `public_ip_id` - The allocation ID of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. + * `public_ip_id` - The allocation ID of the public IP. * `private_dns_name` - The name of the private DNS. * `private_ip` - The private IP address of the NIC. * `security_groups` - One or more IDs of security groups for the NIC. diff --git a/website/docs/r/nic_link.html.markdown b/website/docs/r/nic_link.html.markdown index b56f01a61..abf9a05f3 100644 --- a/website/docs/r/nic_link.html.markdown +++ b/website/docs/r/nic_link.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nic_link Resource Manages a NIC link. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+FNIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-FNIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-nic). ## Example Usage diff --git a/website/docs/r/nic_private_ip.html.markdown b/website/docs/r/nic_private_ip.html.markdown index a89031afa..d1d9afa47 100644 --- a/website/docs/r/nic_private_ip.html.markdown +++ b/website/docs/r/nic_private_ip.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_nic_private_ip Resource Manages a NIC's private IPs. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+FNIs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-FNIs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-nic). ## Example Usage diff --git a/website/docs/r/public_ip.html.markdown b/website/docs/r/public_ip.html.markdown index edf37c370..e81599677 100644 --- a/website/docs/r/public_ip.html.markdown +++ b/website/docs/r/public_ip.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_public_ip Resource Manages a public IP. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+EIPs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-EIPs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-publicip). ## Example Usage @@ -31,16 +31,16 @@ The following arguments are supported: The following attributes are exported: -* `link_public_ip_id` - (Required in a Net) The ID representing the association of the EIP with the VM or the NIC. +* `link_public_ip_id` - (Required in a Net) The ID representing the association of the public IP with the VM or the NIC. * `nic_account_id` - The account ID of the owner of the NIC. -* `nic_id` - The ID of the NIC the EIP is associated with (if any). -* `private_ip` - The private IP address associated with the EIP. -* `public_ip_id` - The allocation ID of the EIP associated with the NAT service. -* `public_ip` - The External IP address (EIP) associated with the NAT service. -* `tags` - One or more tags associated with the EIP. +* `nic_id` - The ID of the NIC the public IP is associated with (if any). +* `private_ip` - The private IP address associated with the public IP. +* `public_ip_id` - The allocation ID of the public IP. +* `public_ip` - The public IP. +* `tags` - One or more tags associated with the public IP. * `key` - The key of the tag, with a minimum of 1 character. * `value` - The value of the tag, between 0 and 255 characters. -* `vm_id` - The ID of the VM the External IP (EIP) is associated with (if any). +* `vm_id` - The ID of the VM the public IP is associated with (if any). ## Import diff --git a/website/docs/r/public_ip_link.html.markdown b/website/docs/r/public_ip_link.html.markdown index c1df4318d..305820424 100644 --- a/website/docs/r/public_ip_link.html.markdown +++ b/website/docs/r/public_ip_link.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_public_ip_link Resource Manages a public IP link. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+EIPs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-EIPs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-publicip). ## Example Usage @@ -41,18 +41,18 @@ resource "outscale_public_ip_link" "public_ip_link01" { The following arguments are supported: -* `allow_relink` - (Optional) If true, allows the EIP to be associated with the VM or NIC that you specify even if it is already associated with another VM or NIC. If false, prevents the EIP from being associated with the VM or NIC that you specify if it is already associated with another VM or NIC. (By default, true in the public Cloud, false in a Net.) -* `nic_id` - (Optional) (Net only) The ID of the NIC. This parameter is required if the VM has more than one NIC attached. Otherwise, you need to specify the `vm_id` parameter instead. You cannot specify both parameters at the same time. +* `allow_relink` - (Optional) If true, allows the public IP to be associated with the VM or NIC that you specify even if it is already associated with another VM or NIC. If false, prevents the public IP from being associated with the VM or NIC that you specify if it is already associated with another VM or NIC. (By default, true in the public Cloud, false in a Net.) +* `nic_id` - (Optional) (Net only) The ID of the NIC. This parameter is required if the VM has more than one NIC attached. Otherwise, you need to specify the `VmId` parameter instead. You cannot specify both parameters at the same time. * `private_ip` - (Optional) (Net only) The primary or secondary private IP address of the specified NIC. By default, the primary private IP address. -* `public_ip_id` - (Optional) The allocation ID of the EIP. This parameter is required unless you use the `public_ip` parameter. -* `public_ip` - (Optional) The EIP. This parameter is required unless you use the `public_ip_id` parameter. +* `public_ip_id` - (Optional) The allocation ID of the public IP. This parameter is required unless you use the `PublicIp` parameter. +* `public_ip` - (Optional) The public IP. This parameter is required unless you use the `PublicIpId` parameter. * `vm_id` - (Optional) The ID of the VM.
- In the public Cloud, this parameter is required.
- In a Net, this parameter is required if the VM has only one NIC. Otherwise, you need to specify the `nic_id` parameter instead. You cannot specify both parameters at the same time. ## Attribute Reference The following attributes are exported: -* `link_public_ip_id` - (Net only) The ID representing the association of the EIP with the VM or the NIC. +* `link_public_ip_id` - (Net only) The ID representing the association of the public IP with the VM or the NIC. ## Import diff --git a/website/docs/r/route.html.markdown b/website/docs/r/route.html.markdown index 14fec7345..46c590bc3 100644 --- a/website/docs/r/route.html.markdown +++ b/website/docs/r/route.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_route Resource Manages a route. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Route+Tables). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Route-Tables.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-route). ## Example Usage diff --git a/website/docs/r/route_table.html.markdown b/website/docs/r/route_table.html.markdown index 1ea09df9c..36f662367 100644 --- a/website/docs/r/route_table.html.markdown +++ b/website/docs/r/route_table.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_route_table Resource Manages a route table. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Route+Tables). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Route-Tables.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-routetable). ## Example Usage diff --git a/website/docs/r/route_table_link.html.markdown b/website/docs/r/route_table_link.html.markdown index 3ae40ef44..24ec5faf3 100644 --- a/website/docs/r/route_table_link.html.markdown +++ b/website/docs/r/route_table_link.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_route_table_link Resource Manages a route table link. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Route+Tables). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Route-Tables.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-routetable). ## Example Usage diff --git a/website/docs/r/security_group.html.markdown b/website/docs/r/security_group.html.markdown index 83eb14698..066df8bcc 100644 --- a/website/docs/r/security_group.html.markdown +++ b/website/docs/r/security_group.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_security_group Resource Manages a security group. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Security+Groups). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Security-Groups.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-securitygroup). ## Example Usage diff --git a/website/docs/r/security_group_rule.html.markdown b/website/docs/r/security_group_rule.html.markdown index 9c3ce921e..eed3eed8d 100644 --- a/website/docs/r/security_group_rule.html.markdown +++ b/website/docs/r/security_group_rule.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_security_group_rule Resource Manages a security group rule. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Security+Group+Rules). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Security-Group-Rules.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-securitygrouprule). ## Example Usage diff --git a/website/docs/r/server_certificate.html.markdown b/website/docs/r/server_certificate.html.markdown index e7108a5f3..d54549e26 100644 --- a/website/docs/r/server_certificate.html.markdown +++ b/website/docs/r/server_certificate.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_server_certificate Resource Manages a server certificate. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Server+Certificates+in+EIM). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Server-Certificates-in-EIM.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-servercertificate). ## Example Usage diff --git a/website/docs/r/snapshot.html.markdown b/website/docs/r/snapshot.html.markdown index 8453d60a3..2f63a528e 100644 --- a/website/docs/r/snapshot.html.markdown +++ b/website/docs/r/snapshot.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_snapshot Resource Manages a snapshot. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Snapshots). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Snapshots.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-snapshot). ## Example Usage diff --git a/website/docs/r/snapshot_attributes.html.markdown b/website/docs/r/snapshot_attributes.html.markdown index 20ad76750..47963d89a 100644 --- a/website/docs/r/snapshot_attributes.html.markdown +++ b/website/docs/r/snapshot_attributes.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_snapshot_attributes Resource Manages snapshot attributes. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Snapshots). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Snapshots.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#updatesnapshot). ## Example Usage diff --git a/website/docs/r/snapshot_export_task.html.markdown b/website/docs/r/snapshot_export_task.html.markdown index e340ef15e..8d11cab08 100644 --- a/website/docs/r/snapshot_export_task.html.markdown +++ b/website/docs/r/snapshot_export_task.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_snapshot_export_task Resource Manages a snapshot export task. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Snapshots). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Snapshots.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-snapshot). ## Example Usage diff --git a/website/docs/r/subnet.html.markdown b/website/docs/r/subnet.html.markdown index 7c74e4514..3c5dff3e3 100644 --- a/website/docs/r/subnet.html.markdown +++ b/website/docs/r/subnet.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_subnet Resource Manages a Subnet. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPCs). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPCs.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-subnet). ## Example Usage @@ -48,7 +48,7 @@ The following attributes are exported: * `available_ips_count` - The number of available IP addresses in the Subnets. * `ip_range` - The IP range in the Subnet, in CIDR notation (for example, 10.0.0.0/16). -* `map_public_ip_on_launch` - If true, a public IP address is assigned to the network interface cards (NICs) created in the specified Subnet. +* `map_public_ip_on_launch` - If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. * `net_id` - The ID of the Net in which the Subnet is. * `state` - The state of the Subnet (`pending` \| `available`). * `subnet_id` - The ID of the Subnet. diff --git a/website/docs/r/virtual_gateway.html.markdown b/website/docs/r/virtual_gateway.html.markdown index a2e43a3c1..6ac0f03df 100644 --- a/website/docs/r/virtual_gateway.html.markdown +++ b/website/docs/r/virtual_gateway.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_virtual_gateway Resource Manages a virtual gateway. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Virtual+Private+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Virtual-Private-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-virtualgateway). ## Example Usage diff --git a/website/docs/r/virtual_gateway_link.html.markdown b/website/docs/r/virtual_gateway_link.html.markdown index e36142075..fd24b4356 100644 --- a/website/docs/r/virtual_gateway_link.html.markdown +++ b/website/docs/r/virtual_gateway_link.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_virtual_gateway_link Resource Manages a virtual gateway link. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Virtual+Private+Gateways). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Virtual-Private-Gateways.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-virtualgateway). ## Example Usage diff --git a/website/docs/r/virtual_gateway_route_propagation.html.markdown b/website/docs/r/virtual_gateway_route_propagation.html.markdown index 8fdaa1767..e61106f59 100644 --- a/website/docs/r/virtual_gateway_route_propagation.html.markdown +++ b/website/docs/r/virtual_gateway_route_propagation.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_virtual_gateway_route_propagation Resource Manages a virtual gateway route propagation. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Routing+Configuration+for+VPN+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#updateroutepropagation). ## Example Usage diff --git a/website/docs/r/vm.html.markdown b/website/docs/r/vm.html.markdown index a287ddcd9..f6d8d94e1 100644 --- a/website/docs/r/vm.html.markdown +++ b/website/docs/r/vm.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vm Resource Manages a virtual machine (VM). -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Instances). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Instances.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-vm). ## Example Usage @@ -51,7 +51,7 @@ resource "outscale_vm" "vm02" { vm_type = var.vm_type keypair_name = var.keypair_name block_device_mappings { - device_name = "/dev/sda" # /dev/sda corresponds to the root device of the VM + device_name = "/dev/sda1" # /dev/sda1 corresponds to the root device of the VM bsu { volume_size = 15 volume_type = "gp2" @@ -199,7 +199,7 @@ For more information about volume types, see [Volume Types and IOPS](https://wik * `private_ips` - (Optional) One or more private IP addresses to assign to the NIC, if you create a NIC when creating a VM. Only one private IP address can be the primary private IP address. * `is_primary` - (Optional) If true, the IP address is the primary private IP address of the NIC. * `private_ip` - (Optional) The private IP address of the NIC. - * `secondary_private_ip_count` - (Optional) The number of secondary private IP addresses, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP address in the `private_ips` parameter. + * `secondary_private_ip_count` - (Optional) The number of secondary private IP addresses, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP address in the `PrivateIps` parameter. * `security_group_ids` - (Optional) One or more IDs of security groups for the NIC, if you acreate a NIC when creating a VM. * `subnet_id` - (Optional) The ID of the Subnet for the NIC, if you create a NIC when creating a VM. * `performance` - (Optional) The performance of the VM (`medium` | `high` | `highest`). Updating this parameter will trigger a stop/start of the VM. @@ -248,20 +248,20 @@ The following attributes are exported: * `device_number` - The device index for the NIC attachment (between 1 and 7, both included). * `link_nic_id` - The ID of the NIC to attach. * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`). - * `link_public_ip` - Information about the EIP associated with the NIC. + * `link_public_ip` - Information about the public IP associated with the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. * `mac_address` - The Media Access Control (MAC) address of the NIC. * `net_id` - The ID of the Net for the NIC. * `nic_id` - The ID of the NIC. * `private_dns_name` - The name of the private DNS. * `private_ips` - The private IP address or addresses of the NIC. * `is_primary` - If true, the IP address is the primary private IP address of the NIC. - * `link_public_ip` - Information about the EIP associated with the NIC. + * `link_public_ip` - Information about the public IP associated with the NIC. * `public_dns_name` - The name of the public DNS. - * `public_ip` - The External IP address (EIP) associated with the NIC. - * `public_ip_account_id` - The account ID of the owner of the EIP. + * `public_ip` - The public IP associated with the NIC. + * `public_ip_account_id` - The account ID of the owner of the public IP. * `private_dns_name` - The name of the private DNS. * `private_ip` - The private IP address. * `security_groups` - One or more IDs of security groups for the NIC. @@ -277,7 +277,7 @@ The following attributes are exported: * `private_ip` - The primary private IP address of the VM. * `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10). * `public_dns_name` - The name of the public DNS. -* `public_ip` - The public IP address of the VM. +* `public_ip` - The public IP of the VM. * `reservation_id` - The reservation ID of the VM. * `root_device_name` - The name of the root device for the VM (for example, /dev/vda1). * `root_device_type` - The type of root device used by the VM (always `bsu`). diff --git a/website/docs/r/volume.html.markdown b/website/docs/r/volume.html.markdown index f26199c83..318414bdf 100644 --- a/website/docs/r/volume.html.markdown +++ b/website/docs/r/volume.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_volume Resource Manages a volume. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Volumes). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Volumes.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-volume). ## Example Usage @@ -28,7 +28,7 @@ resource "outscale_volume" "volume01" { The following arguments are supported: * `iops` - (Optional) The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000`. -* `size` - (Optional) The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (`snapshot_id` unspecified). +* `size` - (Optional) The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (`SnapshotId` unspecified). * `snapshot_id` - (Optional) The ID of the snapshot from which you want to create the volume. * `subregion_name` - (Required) The Subregion in which you want to create the volume. * `tags` - (Optional) A tag to add to this resource. You can specify this argument several times. diff --git a/website/docs/r/volumes_link.html.markdown b/website/docs/r/volumes_link.html.markdown index a5890ee75..3f041dfb6 100644 --- a/website/docs/r/volumes_link.html.markdown +++ b/website/docs/r/volumes_link.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_volumes_link Resource Manages a volume link. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Volumes). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Volumes.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-volume). ## Example Usage diff --git a/website/docs/r/vpn_connection.html.markdown b/website/docs/r/vpn_connection.html.markdown index 77d1b7deb..aac28efe9 100644 --- a/website/docs/r/vpn_connection.html.markdown +++ b/website/docs/r/vpn_connection.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vpn_connection Resource Manages a VPN connection. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+VPN+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-VPN-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-vpnconnection). ## Example Usage diff --git a/website/docs/r/vpn_connection_route.html.markdown b/website/docs/r/vpn_connection_route.html.markdown index c63081b11..5624f0f36 100644 --- a/website/docs/r/vpn_connection_route.html.markdown +++ b/website/docs/r/vpn_connection_route.html.markdown @@ -9,7 +9,7 @@ description: |- # outscale_vpn_connection_route Resource Manages a VPN connection route. -For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Routing+Configuration+for+VPN+Connections). +For more information on this resource, see the [User Guide](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html). For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-vpnconnection). ## Example Usage