Releasing version 3.11.0

Releasing version 3.11.0

Author: lealex262

CHANGELOG.rst

@@ -6,6 +6,36 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__.
 
+3.11.0 - 2022-07-12
+--------------------
+Added
+~~~~~
+* Support to provide database management private endpoint ID as input to enable DBCS databases in the Operations Insights service
+
+  * ``oci opsi database-insights create-pe-comanged-database --dbm-private-endpoint-id``
+
+* Support for the below new fields to create data guard association with new db system in the Database service
+
+  * ``oci db data-guard-association create with-new-db-system --database-defined-tags --database-freeform-tags --db-system-defined-tags --db-system-freeform-tags --fault-domains --license-model --node-count --private-ip --time-zone``
+
+* Support for Native Pod Networking in Oracle Kubernetes Engine service
+
+  * ``oci ce cluster create --cluster-pod-network-options``
+  * ``oci ce node-pool create --max-pods-per-node --pod-nsg-ids --pod-subnet-ids``
+  * ``oci ce node-pool update --max-pods-per-node --pod-nsg-ids --pod-subnet-ids``
+
+* Support for Compute Instance Maintenance in the Compute service
+
+  * ``oci compute instance action --action rebootmigrate``
+
+Changed
+~~~~~~~
+* [BREAKING] The confusing flag naming for preserving data volumes created on instance launch --preserve-data-volumes is removed in the compute service
+
+  * ``oci compute instance terminate --preserve-data-volumes``
+
+* Bug fixes and improvements to project_o
+
 3.10.5 - 2022-06-28
 --------------------
 Added

requirements.txt

@@ -14,7 +14,7 @@ Jinja2==3.0.3
 jmespath==0.10.0
 ndg-httpsclient==0.4.2
 mock==2.0.0
-oci==2.73.0
+oci==2.75.0
 packaging==20.2
 pluggy==0.13.0
 py==1.10.0

scripts/examples/project_o/README.md

@@ -55,13 +55,14 @@ Public Subnet VLKn:US-ASHBURN-AD-1 AVAILABLE 10.0.0.0/24 sales
    - *instantly* get usage help as you search for the command
    - *concise* usage typically fits on one screen - no scrolling or searching for the parameter you want
  - expand parameter shortcuts into full parameter names
+   - use the first letter of each word for any multi-word parameter, e.g. ``-wfs`` expands to <nobr>``--wait-for-state``</nobr>
  - accept *resource name* in place of OCID values
  - resolve ambiguous *resource name*s
    - resources can be identified by *compartment/name*
    - finds match for partial entry of *name*, *display-name*, *compartment*/*name*
-   - identical names can be resolved by using partial OCID.
-     - for example, ``-c ujfa`` would specify the *sales* compartment. Four or five characters will uniquely identify most resources.
-   - handy when your resource names contain spaces or special characters
+   - identical names can be resolved by using a substring from the OCID
+     - for example, ``-c ujfa`` would specify the *sales* compartment. The last four to six characters will uniquely identify most resources.
+     - handy when your resource names contain spaces or special characters
  - support [complex type] parameters where a list of OCIDs is expected
    - comma-separated resource names are converted to a JSON list
  - simplify [datetime] parameters
@@ -72,7 +73,7 @@ Public Subnet VLKn:US-ASHBURN-AD-1 AVAILABLE 10.0.0.0/24 sales
     - *table:* `-o display#lifecycle` or `-o 'display|lifecycle'`
     - *text:* `-o display/lifecycle` - displays one field per line
     - *csv:*  `-o display,lifecycle`
-    - *JSON:* `-o json` Show all attributes in unfiltered JSON
+    - *JSON:* `-o json` Show unfiltered JSON output from ``oci``
     - Advanced: custom (pythonic) string formatting to truncate long values<br>
       `-o 'display{:.20}|create{:10.10}|id{:>8.8}'` will show a table of:
       - the first 20 characters of *display-name*  The column with be sized to fit the longest name, up to a maximum of 20 characters.
@@ -89,24 +90,25 @@ Public Subnet VLKn:US-ASHBURN-AD-1 AVAILABLE 10.0.0.0/24 sales
     - `o ocid  sales/bastion` *instantly* shows the full OCIDs for all compartments
 
 ## How **``o``** works  
- - **``o``** compares your input with more than two thousand ``oci`` commands, and uses an intelligent algorithm to find the best match.
+ - **``o``** compares your input with thousands of ``oci`` commands, and uses an intelligent algorithm to find the best match.
 
- - **``o``** then provides a usage synopsis, showing required and optional parameters.  Add "help" to the end to see global parameters as well.  End with ``--help go`` to get full ``oci <command> --help``.
+ - **``o <command>``** provides a usage synopsis, showing required and optional parameters for matching commands.  Add "help" to the end to see global parameters as well.  E.g. <nobr>``o <command> help``</nobr> provides the usage synopsis with global parameters, while <nobr>``o <command> --help go``</nobr> runs <nobr>``oci <command> --help``</nobr>.
 
  - You add option and parameter shortcuts, and **``o``** shows you the complete ``oci`` command line after performing command, option, and parameter expansions and substitutions.
 
- - **`o`** options such as `o -o field#list` must appear *before* the `<service resource command>`  specification. `oci` options must appear *after* `command`.  While this option ordering is not strictly required by `oci`, `o` needs this ordering to tell which options are for `o` and which are for `oci`.
+ - Options for **`o`** such as `-o field#list` must appear *before* the `<command>`  specification. `oci` options must appear *after* `<command>`.  While this ordering is not strictly required by `oci`, `o` uses this to determine which options are for `o` and which are for `oci`.
 
- - Add "go" to the end of the command and **``o``** will execute the ``oci`` command.  ``oci`` typically returns JSON data when you create, get, list, or update resources.
+ - Add `go` or `.` to the end of the command and **``o``** will execute the ``oci`` command.
 
- - **``o``** inspects the JSON results and collects selected of details about your OCI resources whenever you run any command with ``o ... go``. Most importantly, **``o``** captures resource names and Oracle Cloud IDs (OCIDs). Details are saved to your *$HOME/.oci/ocids* file. **``o``** uses this information to find resources by name, and to translate names to IDs.
+ - ``oci`` returns JSON data when you create, get, list, or update resources.  **``o``** captures resource names and Oracle Cloud IDs (OCIDs) and saves these to your *$HOME/.oci/ocids* file. **``o``** later uses this information to find resources by name, and to translate names to IDs.
 
- - Once **``o``** receives JSON results from oci, it scans the returned data dict for key names that match or partially match any of your <nobr>``-o key/word/list``</nobr>.  The key words determine *what* presented, while the **``/``** separator character determines *how* they are presented.
+ - **``o``** scans the JSON results from ``oci`` for key names that match or partially match any of your <nobr>``-o key/word/list``</nobr>.  The key words determine *what* presented, while the **``/``** separator character determines *how* they are presented.
 
 ##  Requirements
 
 You will need:
 
+- MacOS, Linux or WSL.
 - Python 3.6+.  If ``oci`` is installed, you have Python.
 - ``oci`` - The Oracle Cloud Infrastructure command line interface must be *installed and configured*.
   - Try running ``oci os ns get`` to verify that it's working.
@@ -127,11 +129,23 @@ When you first run `o` it will tell you how to create the commands file *$HOME/.
 
 **OCIDs File**
 
-**``o``** uses a local cache of OCID-name mappings called the OCIDs file, located at `.oci/ocids`. If you need to update the OCIDs file after first usage, simply run `o <tenancy_ocid>`.
+**``o``** uses a local cache of OCID-to-name mappings called the OCIDs file, located at *$HOME/.oci/ocids*.  This is populated during setup when you run `o <tenancy_ocid>`.  
 
-**Advanced Setup and Usage**
+To use **``o``** with additional tenancies, simply set your OCI_CLI_PROFILE and run `o <tenancy_ocid>` with the new tenancy OCID.
+
+As resources are deleted from your tenancy, **``o``** does automatically remove these from the OCIDs file.  Also, as other tenancy users make changes in the tenancy, these changes won't be reflected in your OCIDs file.  When these stale OCIDs cause problems with ``o``'s name matching, they may be removed from the OCIDs file with ``o prune <resource-name>``.  Or you can start with a fresh OCIDs file by removing  *$HOME/.oci/ocids* and run `o <tenancy_ocid>`.
+
+**oci_commands File**
+
+When you run `o oci_commands`, `o` takes a minute or two to build a list of the thousands of possible `oci` commands with their options, and saves this to *$HOME/.oci/oci_commands*.  This list is generated on your system to ensure that it matches the commands in your installed version of `oci`.
 
-When you run `o oci_commands`, it takes about a minute to create a list of thousands of possible `oci` commands and their options, and save this to *$HOME/.oci/ocids*.  In some cases your `oci` command line environment may be installed without preformatted documentation.  In this case it may take 30 to 60 minutes to gather the command information.
+In some cases (in Oracle provided OS images) the `oci` command line environment come be pre-installed, but with incomplete documentation.  If so, `o` may take an hour or more to gather the command information.  To avoid this you can: copy an *oci_commands* file from another source (preferably with a similar `oci` version) to *$HOME/.oci/oci_commands*; or reinstall oci-cli to ensure the full documentation is included.
+
+`oci_commands` should be rebuilt after updating or reinstalling oci-cli.  To do this:
+ - remove the old file:  `rm $HOME/.oci/oci_commands`
+ - Rebuild with: `oci oci_commands`
+
+**Advanced Setup and Usage**
 
 If you use ``oci`` with *instance_principal* authentication, set `` OCI_CLI_AUTH=instance_principal`` in your environment
 (rather than use <nobr>``--auth instance_principal``</nobr> with each command).
@@ -153,7 +167,7 @@ If you use ``oci`` for multiple tenancies, by default ``o`` will save OCIDs for
 Keep it simple.  
 
  - **``o``** does not have a configuration file
- - **``o``** does not use environment variables
+ - **``o``** does not use environment variables (``oci`` does)
  - **``o``** minimizes typing (thus its one-letter name)
  - **``o``** is forgiving
    - accepts plurals when singular is expected