Retire ec2-api: remove repo content

ec2-api project is retiring
- https://review.opendev.org/c/openstack/governance/+/919394/1

this commit remove the content of this project repo

Depends-On: https://review.opendev.org/c/openstack/project-config/+/919396/1
Change-Id: I671d27260e11ec0ae3488acf561bbdaa73a29a60
This commit is contained in:
Ghanshyam Mann 2024-05-10 18:08:31 -07:00
parent 32740781f6
commit d61398b5d9
170 changed files with 8 additions and 37568 deletions

24
.gitignore vendored
View File

@ -1,24 +0,0 @@
*.pyc
*~
etc/ec2api/ec2api.conf.sample
.project
.pydevproject
ec2_api.egg-info
.tox
.stestr
*.log
*.egg
*.swp
*.swo
build
dist
.testrepository
/functional_tests.conf*
/buckets
.venv
.coverage*
!.coveragerc
cover/
.idea
ec2api/tests/unit/test_cert.pem
.DS_Store

View File

@ -1,3 +0,0 @@
[DEFAULT]
test_path=./ec2api/tests/unit
top_dir=./

View File

@ -1,12 +0,0 @@
- project:
queue: ec2-api
templates:
- check-requirements
- openstack-python3-jobs
- publish-openstack-docs-pti
check:
jobs:
- ec2api-tempest-plugin-functional
gate:
jobs:
- ec2api-tempest-plugin-functional

View File

@ -1,19 +0,0 @@
The source repository for this project can be found at:
https://opendev.org/openstack/ec2-api
Pull requests submitted through GitHub are not monitored.
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Launchpad:
https://bugs.launchpad.net/ec2-api
For more specific information about contributing to this repository, see the
ec2-api contributor guide:
https://docs.openstack.org/ec2-api/latest/contributor/contributing.html

View File

@ -1,43 +0,0 @@
Ec2api Style Commandments
=========================
- Step 1: Read the OpenStack Style Commandments
https://github.com/openstack-dev/hacking/blob/master/doc/source/index.rst
- Step 2: Read on
Ec2api Specific Commandments
----------------------------
General
-------
- Do not use locals(). Example::
LOG.debug("volume %(vol_name)s: creating size %(vol_size)sG" %
locals()) # BAD
LOG.debug("volume %(vol_name)s: creating size %(vol_size)sG" %
{'vol_name': vol_name,
'vol_size': vol_size}) # OKAY
- Use 'raise' instead of 'raise e' to preserve original traceback or exception being reraised::
except Exception as e:
...
raise e # BAD
except Exception:
...
raise # OKAY
Creating Unit Tests
-------------------
For every new feature, unit tests should be created that both test and
(implicitly) document the usage of said feature. If submitting a patch for a
bug that had no unit test, a new passing unit test should be added. If a
submitted bug fix does have a unit test, be sure to add a new one that fails
without the patch and passes with the patch.
For more information on creating unit tests and utilizing the testing
infrastructure in OpenStack Ec2api, please read ec2api/testing/README.rst.

176
LICENSE
View File

@ -1,176 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

View File

@ -1,700 +1,10 @@
=================
OpenStack EC2 API
=================
This project is no longer maintained.
.. image:: https://governance.openstack.org/tc/badges/ec2-api.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
The contents of this repository are still available in the Git
source code management system. To see the contents of this
repository before it reached its end of life, please check out the
previous commit with "git checkout HEAD^1".
.. Change things from this point on
Support of EC2 API for OpenStack.
This project provides a standalone EC2 API service which pursues two goals:
1. Implement VPC API
2. Create a standalone service for EC2 API support.
Installation
------------
For more detailed information, please see the `Installation Guide <https://docs.openstack.org/ec2-api/latest/install/index.html>`_.
Installation by install.sh
==========================
Run install.sh
The EC2 API service gets installed on port 8788 by default. It can be changed
before the installation in install.sh script.
The services afterwards can be started as binaries:
::
/usr/local/bin/ec2-api
/usr/local/bin/ec2-api-metadata
/usr/local/bin/ec2-api-s3
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
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
::
git clone https://opendev.org/openstack/devstack
3. grant all permissions for your user for directory: "/opt"
4. create folder "/opt/stack/logs/"
5. clone repository "ec2api-tempest-plugin" to stack folder:
::
git clone https://github.com/openstack/ec2api-tempest-plugin /opt/stack/ec2api-tempest-plugin
6. create local.conf:
::
[[local|localrc]]
ADMIN_PASSWORD=secret
DATABASE_PASSWORD=$ADMIN_PASSWORD
RABBIT_PASSWORD=$ADMIN_PASSWORD
SERVICE_PASSWORD=$ADMIN_PASSWORD
enable_plugin ec2-api https://opendev.org/openstack/ec2-api
enable_plugin neutron-tempest-plugin https://github.com/openstack/neutron-tempest-plugin
TEMPEST_PLUGINS='/opt/stack/ec2api-tempest-plugin'
7. go to devstack folder and start installation
::
cd ~/devstack/
./stack.sh
8. check installed devstack
::
source ~/devstack/accrc/admin/admin
tempest list-plugins
ps -aux | grep "ec2"
aws --endpoint-url http://<IP-ADDRESS> --region <REGION> --profile admin ec2 describe-images
openstack catalog list
openstack flavor list
openstack image list
sudo journalctl -u devstack@ec2-api.service
9. run integration tests (ec2 tempest test)
::
cd /opt/stack/tempest
tox -eall -- ec2api_tempest_plugin --concurrency 1
tox -eall ec2api_tempest_plugin.api.test_network_interfaces.NetworkInterfaceTest.test_create_max_network_interface
10. run ec2-api unit tests
::
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
add::
[DEFAULT]
metadata_port = 8789
[neutron]
service_metadata_proxy = True
to /etc/nova.conf
then restart nova-metadata (can be run as part of nova-api service) and
nova-network services.
for Neutron
add::
[DEFAULT]
nova_metadata_port = 8789
to /etc/neutron/metadata_agent.ini for legacy neutron or
to neutron_ovn_metadata_agent.ini for OVN
then restart neutron-metadata service.
S3 server is intended only to support EC2 operations which require S3 server
(e.g. CreateImage) in OpenStack deployments without regular object storage.
It must not be used as a substitution for all-purposes object storage server.
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:
::
[default]
aws_access_key_id = 1b013f18d5ed47ae8ed0fbb8debc036b
aws_secret_access_key = 9bbc6f270ffd4dfdbe0e896947f41df3
region = us-east-1
Change the aws_access_key_id and aws_secret_acces_key above to the values
appropriate for your cloud (can be obtained by "openstack ec2 credentials list"
command).
Run aws cli commands using new EC2 API endpoint URL (can be obtained from
openstack cli with the new port 8788) like this:
aws --endpoint-url http://10.0.2.15:8788 ec2 describe-instances
Supported Features and Limitations
----------------------------------
General:
* DryRun option is not supported.
* Some exceptions are not exactly the same as reported by AWS.
+----------+------------------------------------------+-----------------+----------------------------------------+
| AWS | Command | Functionality | Limitations |
| Component| | group | |
+==========+==========================================+=================+========================================+
| | **bold** - supported, normal - supported | | |
| | with limitations, *italic* -not supported| | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *AcceptVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **AllocateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AllocateHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssignIpv6Addresses* | network | not supported |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | AssignPrivateIpAddresses | network | allowReassignment parameter |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **AssociateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AssociateDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AssociateRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssociateSubnetCidrBlock* | subnets | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssociateVpcCidrBlock* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *AttachClassicLinkVpc* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachInternetGateway** | internet | |
| | | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, EBS | **AttachVolume** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | AuthorizeSecurityGroupEgress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | AuthorizeSecurityGroupIngress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *BundleInstance* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelBundleTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelConversionTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelExportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelImportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelReservedInstancesListing* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelSpotFleetRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelSpotInstanceRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ConfirmProductInstance* | product codes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *CopyImage* | image | not supported |
| | | provisioning | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *CopySnapshot* | snapshots,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateCustomerGateway | VPC gateways | BGPdynamicrouting |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateEgressOnlyInternetGateway* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | CreateImage | images | blockDeviceMapping parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateInstanceExportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateInternetGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **CreateKeyPair** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateNatGateway* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateNetworkAcl* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreatePlacementGroup* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateReservedInstancesListing* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateRoute | routes | vpcPeeringConnection parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **CreateSecurityGroup** | security groups | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **CreateSnapshot** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateSubnet | subnets | availabilityZone parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **CreateTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | CreateVolume | volumes | iops, encrypted, kmsKeyId parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateVpc** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateVpcEndpoint* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateVpnConnection | VPN | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateVpnConnectionRoute** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateVpnGateway | VPN | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteCustomerGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteEgressOnlyInternetGateway* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteInternetGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DeleteKeyPair** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteNatGateway* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteNetworkAcl* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | *DeletePlacementGroup* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteRoute** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DeleteSecurityGroup** | security groups | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeleteSnapshot** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteSubnet** | subnets | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DeleteTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeleteVolume** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpc** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteVpcEndpoints* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnConnection** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnConnectionRoute** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeregisterImage** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeAccountAttributes | infrastructural | vpc-max-security-groups-per-interface, |
| | | | max-elastic-ips, |
| | | | vpc-max-elastic-ips attributes |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DescribeAddresses** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeAvailabilityZones** | availability | |
| | | zones | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeBundleTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeClassicLinkInstances* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeConversionTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeCustomerGateways** | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeEgressOnlyInternetGateways* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeExportTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeIdentityIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | DescribeImageAttribute | images | productCodes, sriovNetSupport |
| | | | attributes |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeImages** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeImportImageTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeImportSnapshotTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeInstanceAttribute | instances | same limitations as for |
| | | | ModifyInstanceAttribute |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, | **DescribeInstances** | instances | |
| EBS, VPC | | | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeInstanceStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeInternetGateways** | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeKeyPairs** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeMovingAddresses* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeNatGateways* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeNetworkAcls* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeNetworkInterfaceAttribute** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeNetworkInterfaces** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | *DescribePlacementGroups* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribePrefixLists* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeRegions | availability | RegionNameparameter |
| | | zones | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesListings* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesModifications* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesOfferings* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeRouteTables** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeScheduledInstanceAvailability* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeScheduledInstances* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSecurityGroupReferences* | security groups | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | DescribeSecurityGroups | security groups | cidr, protocol, port, sourceGroup |
| | | | parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *DescribeSnapshotAttribute* | snapshots | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeSnapshots** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetRequestHistory* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotInstanceRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotPriceHistory* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeStaleSecurityGroups* | security groups | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeSubnets** | subnets | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *DescribeVolumeAttribute* | volumes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeVolumes** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeVolumeStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcAttribute* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcClassicLink* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeVpcClassicLinkDnsSupport* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcEndpoints* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcEndpointServices* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcPeeringConnections* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeVpcs** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeVpnConnections** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeVpnGateways** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DetachClassicLinkVpc* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DetachInternetGateway** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DetachNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, EBS | DetachVolume | volumes | instance_id, device, force parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DetachVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DisableVgwRoutePropagation** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DisableVpcClassicLink* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DisableVpcClassicLinkDnsSupport* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DisassociateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DisassociateRouteTable** | routes | |
| | *DisassociateSubnetCidrBlock* | subnets | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DisassociateVpcCidrBlock* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **EnableVgwRoutePropagation** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *EnableVolumeIO* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *EnableVpcClassicLink* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *EnableVpcClassicLinkDnsSupport* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **GetConsoleOutput** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *GetConsoleScreenshot* | instances | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **GetPasswordData** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportImage* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportInstance* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **ImportKeyPair** | keypairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportSnapshot* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ImportVolume* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyIdentityIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | ModifyImageAttribute | images | productCodes attribute |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | ModifyInstanceAttribute | instances | only disableApiTermination, |
| | | | sourceDestCheck,instanceType supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyInstancePlacement* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ModifyNetworkInterfaceAttribute** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyReservedInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *ModifySnapshotAttribute* | snapshots | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifySpotFleetRequest* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ModifySubnetAttribute* | subnets | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *ModifyVolumeAttribute* | volumes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ModifyVpcAttribute* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ModifyVpcEndpoint* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ModifyVpcPeeringConnectionOptions* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *MonitorInstances* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *MoveAddressToVpc* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *PurchaseReservedInstancesOffering* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *PurchaseScheduledInstances* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **RebootInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | RegisterImage | images | virtualizationType, sriovNetSupport |
| | | | parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *RejectVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **ReleaseAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ReleaseHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ReplaceNetworkAclAssociation* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *ReplaceNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ReplaceRoute** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ReplaceRouteTableAssociation** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ReportInstanceStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *RequestSpotFleet* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *RequestSpotInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **ResetImageAttribute** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | ResetInstanceAttribute | instances | same limitations as for |
| | | | ModifyInstanceAttribute |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **ResetNetworkInterfaceAttribute** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *ResetSnapshotAttribute* | snapshots | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *RestoreAddressToClassic* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | RevokeSecurityGroupEgress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | RevokeSecurityGroupIngress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, | RunInstances | instances | placement, block_device_mapping partial|
| VPC, EBS | | | support, monitoring, |
| | | | iamInstanceProfile, ebsOptimized, |
| | | | shutdownInitiatedInstanceBehavior |
| | | | parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *RunScheduledInstances* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **StartInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **StopInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **TerminateInstances** | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *UnassignIpv6Addresses* | network | not supported |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **UnassignPrivateIpAddresses** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *UnmonitorInstances* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
References
----------
Documentation:
https://docs.openstack.org/ec2-api/latest/
Wiki:
https://wiki.openstack.org/wiki/EC2API
Bugs:
https://launchpad.net/ec2-api
Source:
https://opendev.org/openstack/ec2-api
Blueprint:
https://blueprints.launchpad.net/nova/+spec/ec2-api
Spec:
https://review.opendev.org/#/c/147882/
For any further questions, please email
openstack-discuss@lists.openstack.org or join #openstack-dev on
OFTC.

View File

@ -1,221 +0,0 @@
# -*- coding: utf-8 -*-
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# nova documentation build configuration file, created by
# sphinx-quickstart on Sat May 1 15:17:47 2010.
#
# This file is execfile()d with the current directory set to
# its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
import sys
extensions = [
'os_api_ref',
'openstackdocstheme'
]
html_theme = 'openstackdocs'
html_theme_options = {
"sidebar_mode": "toc",
}
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/ec2-api'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'ec2-api'
openstackdocs_bug_tag = ''
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'EC2 API Reference'
copyright = u'OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# from ec2-api.version import version_info
# The full version, including alpha/beta/rc tags.
# release = version_info.release_string()
# The short X.Y version.
# version = version_info.version_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# The reST default role (used for this markup: `text`) to use
# for all documents.
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'native'
# -- Options for man page output ----------------------------------------------
# Grouping the document tree for man pages.
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_use_modindex = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'ec2apidoc'
# -- Options for LaTeX output -------------------------------------------------
# The paper size ('letter' or 'a4').
# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'Ec2api.tex', u'OpenStack EC2 API Documentation',
u'OpenStack Foundation', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
# latex_preamble = ''
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_use_modindex = True

View File

@ -1,13 +0,0 @@
:tocdepth: 2
========
EC2 API
========
Provides a standalone EC2 API service.
Amazon EC2 API Reference can be found `here
<http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html>`_.
.. include:: supported_features.inc

View File

@ -1,503 +0,0 @@
.. -*- rst -*-
Supported features and limitations
----------------------------------
General:
* DryRun option is not supported.
* Some exceptions are not exactly the same as reported by AWS.
+----------+------------------------------------------+-----------------+----------------------------------------+
| AWS | Command | Functionality | Limitations |
| Component| | group | |
+==========+==========================================+=================+========================================+
| | **bold** - supported, normal - supported | | |
| | with limitations, *italic* -not supported| | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *AcceptVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **AllocateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AllocateHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssignIpv6Addresses* | network | not supported |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | AssignPrivateIpAddresses | network | allowReassignment parameter |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **AssociateAddress** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AssociateDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AssociateRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssociateSubnetCidrBlock* | subnets | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *AssociateVpcCidrBlock* | VPC | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *AttachClassicLinkVpc* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachInternetGateway** | internet | |
| | | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, EBS | **AttachVolume** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **AttachVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | AuthorizeSecurityGroupEgress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | AuthorizeSecurityGroupIngress | security groups | EC2 classic way to pass cidr, protocol,|
| | | | sourceGroup, ports parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *BundleInstance* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelBundleTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelConversionTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelExportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelImportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelReservedInstancesListing* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelSpotFleetRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CancelSpotInstanceRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *ConfirmProductInstance* | product codes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *CopyImage* | image | not supported |
| | | provisioning | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *CopySnapshot* | snapshots,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateCustomerGateway | VPC gateways | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateEgressOnlyInternetGateway* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | CreateImage | images | blockDeviceMapping parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateInstanceExportTask* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateInternetGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **CreateKeyPair** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateNatGateway* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateNetworkAcl* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreatePlacementGroup* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateReservedInstancesListing* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateRoute | routes | vpcPeeringConnection parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **CreateSecurityGroup** | security groups | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **CreateSnapshot** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *CreateSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateSubnet | subnets | availabilityZone parameter |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **CreateTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | CreateVolume | volumes | iops, encrypted, kmsKeyId parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateVpc** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateVpcEndpoint* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *CreateVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateVpnConnection | VPN | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **CreateVpnConnectionRoute** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | CreateVpnGateway | VPN | BGP dynamic routing |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteCustomerGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteEgressOnlyInternetGateway* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteInternetGateway** | VPC gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DeleteKeyPair** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteNatGateway* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteNetworkAcl* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteNetworkAclEntry* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteNetworkInterface** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | *DeletePlacementGroup* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteRoute** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteRouteTable** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DeleteSecurityGroup** | security groups | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeleteSnapshot** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DeleteSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteSubnet** | subnets | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DeleteTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeleteVolume** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpc** | VPC | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteVpcEndpoints* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DeleteVpcPeeringConnection* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnConnection** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnConnectionRoute** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DeleteVpnGateway** | VPN | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DeregisterImage** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeAccountAttributes | infrastructural | vpc-max-security-groups-per-interface, |
| | | | max-elastic-ips, |
| | | | vpc-max-elastic-ips attributes |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | **DescribeAddresses** | addresses | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeAvailabilityZones** | availability | |
| | | zones | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeBundleTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeClassicLinkInstances* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeConversionTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeCustomerGateways** | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeDhcpOptions** | DHCP options | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeEgressOnlyInternetGateways* | VPC gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeExportTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeFlowLogs* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeHosts* | dedicated hosts | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeIdentityIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeIdFormat* | resource IDs | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | DescribeImageAttribute | images | productCodes, sriovNetSupport |
| | | | attributes |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeImages** | images | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeImportImageTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeImportSnapshotTasks* | tasks,s3 | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeInstanceAttribute | instances | same limitations as for |
| | | | ModifyInstanceAttribute |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, | **DescribeInstances** | instances | |
| EBS, VPC | | | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeInstanceStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeInternetGateways** | gateways | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeKeyPairs** | key pairs | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeMovingAddresses* | infrastructural | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeNatGateways* | NAT gateways | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeNetworkAcls* | ACL | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeNetworkInterfaceAttribute** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeNetworkInterfaces** | network | |
| | | interfaces | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | *DescribePlacementGroups* | clusters | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribePrefixLists* | cross-VPC | not supported |
| | | connectivity | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | DescribeRegions | availability | RegionNameparameter |
| | | zones | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesListings* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesModifications* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeReservedInstancesOfferings* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeRouteTables** | routes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeScheduledInstanceAvailability* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeScheduledInstances* | scheduled | not supported |
| | | instances | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSecurityGroupReferences* | security groups | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2, VPC | DescribeSecurityGroups | security groups | cidr, protocol, port, sourceGroup |
| | | | parameters |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *DescribeSnapshotAttribute* | snapshots | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeSnapshots** | snapshots | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotDatafeedSubscription* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetInstances* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetRequestHistory* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotFleetRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotInstanceRequests* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeSpotPriceHistory* | market | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeStaleSecurityGroups* | security groups | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | **DescribeSubnets** | subnets | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EC2 | **DescribeTags** | tags | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | *DescribeVolumeAttribute* | volumes | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| EBS | **DescribeVolumes** | volumes | |
+----------+------------------------------------------+-----------------+----------------------------------------+
| | *DescribeVolumeStatus* | monitoring | not supported |
+----------+------------------------------------------+-----------------+----------------------------------------+
| VPC | *DescribeVpcAttribute* | VPC | not supported |