From 24a9c69551d7010141b5d44939a17f328b3f9928 Mon Sep 17 00:00:00 2001 From: Xingjian Zhang Date: Mon, 26 Sep 2022 15:55:07 +0800 Subject: [PATCH] doc: Fix docs about installation Change-Id: I0179c718926b3b2100859d7f66dcc6603594abf0 --- README.rst | 36 ++++++++++++++++++++-------- doc/source/install/configuration.rst | 7 ++++++ 2 files changed, 33 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 991c39b2..18be1eec 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,12 @@ -======================== -Team and repository tags -======================== +================= +OpenStack EC2 API +================= .. image:: https://governance.openstack.org/tc/badges/ec2-api.svg :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on -OpenStack EC2 API README ------------------------- - Support of EC2 API for OpenStack. This project provides a standalone EC2 API service which pursues two goals: @@ -17,7 +14,12 @@ This project provides a standalone EC2 API service which pursues two goals: 2. Create a standalone service for EC2 API support. Installation -============ +------------ + +For more detailed information, please see the `Installation Guide `_. + +Installation by install.sh +========================== Run install.sh @@ -34,6 +36,11 @@ The services afterwards can be started as binaries: or set up as Linux services. +Configuring OpenStack for EC2 API metadata service refering to section "EC2 metadata Configuration". + +Installation on devstack +======================== + Installation in devstack: In order to install ec2-api with devstack the following should be added to @@ -44,6 +51,7 @@ the local.conf or localrc the following line: enable_plugin ec2-api https://opendev.org/openstack/ec2-api Devstack installation with ec2-api and ec2api-tempest-plugin for development: + 1. install packages: awscli, git, python3, python3-devel, ruby 2. clone devstack repository @@ -107,6 +115,11 @@ Devstack installation with ec2-api and ec2api-tempest-plugin for development: cd /opt/stack/ec2-api tox -epy36 ec2api.tests.unit.test_security_group.SecurityGroupTestCase.test_describe_security_groups_no_default_vpc +Configuring OpenStack for EC2 API metadata service refering to section "EC2 metadata Configuration". + +EC2 metadata Configuration +========================== + To configure OpenStack for EC2 API metadata service: for Nova-network @@ -140,7 +153,7 @@ Do not start it if the deployment has its own object storage or uses a public one (e.g. AWS S3). Usage -===== +----- Download aws cli from Amazon. Create configuration file for aws cli in your home directory ~/.aws/config: @@ -163,7 +176,7 @@ aws --endpoint-url http://10.0.2.15:8788 ec2 describe-instances Supported Features and Limitations -================================== +---------------------------------- General: * DryRun option is not supported. @@ -666,7 +679,10 @@ General: References -========== +---------- + +Documentation: +https://docs.openstack.org/ec2-api/latest/ Wiki: https://wiki.openstack.org/wiki/EC2API diff --git a/doc/source/install/configuration.rst b/doc/source/install/configuration.rst index a3c5e41c..2393deac 100644 --- a/doc/source/install/configuration.rst +++ b/doc/source/install/configuration.rst @@ -47,6 +47,13 @@ Also you need to configure database connection: [database] connection = mysql+pymysql://root:password@127.0.0.1/ec2api?charset=utf8 +and you need to configure oslo_concurrency lock_path: + +.. code-block:: ini + + [oslo_concurrency] + lock_path = /path/to/oslo_concurrency_lock_dir + and cache if you want to use it. .. code-block:: ini