Skip to content

Commit

Permalink
New left-hand TOC (#599)
Browse files Browse the repository at this point in the history
* Create migrate-e2e.rst

* Add back my new files

* add blank line

* fix links

* fix image

* fix second level list

* add another blank line

* Add another blank line

* Get rid of hidden return

* change image ref

* fix image ref

* note spacing

* change link

* delete invisible return

* fix ref

* remove extra file

* moved the contents elsewhere

* delete unnecessary file

* delete unneeded job

* Add links to use cases

* Moved this content into another file

* Add one more section

* add links to migration examples

* add some new files

* adding some cloud files

* add some more files

* check in auditing file

* fix image links

* fix code blocks

* try to fix link error

* fix links

* change to nbgallery

* fix link format

* fix link

* fix link

* fix primitives

* fix code block

* Update appid-cloud-org.rst

* update the table

* table

* fix links

* Add remaining cloud topics

* fix link

* terraform isn't supported

* change title

* call correct image

* trying one more time to get regular links to work for the notebooks

* change links to tutorials

* change to links

* fix TOC

* remove unused files

* fix links

* fixes

* Try new interdoc link format

* try second link style

* update tutorials

* fix links

* add period

* fix overline

* kill Previous Versions

* Change h1 to h3

* shorten title

* Add & remove topics

* new topic

* remove unused file

* fix image link

* get rid of unneeded file

* add remove files

* fix toc

* updating stuff

* fix table

* try indenting second line of bullet

* fix code blocks

* add resiliance levels

* fix links

* fix math

* fix code block

* move over raw calls

* add another anchor

* move anchor

* update image link

* add image path

* add last link and pray that it works

* Fix H1s

* fix inline code

* fix link titles

* try to fix table links

* fix math

* move around tutorials

* account management page

* fix links

* fix code

* remove migrate topics

* fix heading levels

* fix compare table

* jessie comments

Co-authored-by: Jessie Yu <[email protected]>
  • Loading branch information
beckykd and jyu00 authored Nov 9, 2022
1 parent 65a93ed commit ab7486d
Show file tree
Hide file tree
Showing 76 changed files with 5,921 additions and 6,057 deletions.
4 changes: 0 additions & 4 deletions docs/_templates/versions.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="rst-current-version-label">{{ version_label }}</span>
<span class="rst-versions-dropdown-icon"></span>
</span>
<div class="rst-other-versions">
{% if translations %}
<dl>
Expand Down
15 changes: 15 additions & 0 deletions docs/cloud/architecture-workload-isolation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Learning about Qiskit Runtime architecture and workload isolation
=================================================================


Qiskit Runtime jobs run in individual containers in an internal Kubernetes cluster to isolate jobs from any other activities of other users. Jobs are not shared or visible between service instances. However, all users that can access a service instance can see that instance’s jobs, or submit jobs the account owner might be charged for.


Restricting Access to service instances
---------------------------------------

With Qiskit Runtime, you can create service instances that are IAM-managed resources. Accordingly, IAM-based access control can be used for these service instances.
User access to Qiskit Runtime service instances can be configured through different mechanisms:
- Resource groups can be used to group service instances. This lets you manage access permissions based on resource group assignment.
- Access groups can be used to assign access to individual service instances. Service IDs (with their API keys) can be assigned to these access groups.
- IAM tags can be used to categorize service instances and use these tags through access groups.
38 changes: 38 additions & 0 deletions docs/cloud/at-events.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Audit events for Qiskit Runtime
===============================

As a security officer, auditor, or manager, you can use the IBM Cloud® Activity Tracker service to track how users and applications interact with the Qiskit Runtime service in IBM Cloud.

IBM Cloud Activity Tracker records user-initiated activities that change the state of a service in IBM Cloud. You can use this service to investigate abnormal activity and critical actions and to comply with regulatory audit requirements. In addition, you can be alerted about actions as they happen. The events that are collected comply with the Cloud Auditing Data Federation (CADF) standard. For more information, see the `getting started tutorial for IBM Cloud Activity Tracker <https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-getting-started>`__.

List of data events
-------------------

The following table lists the Qiskit Runtime actions that generate an event:

+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| Action | Description |
+======================================+=================================================================================================================================================+
| ``quantum-computing.program.create`` | An event is generated a program is uploaded. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``quantum-computing.program.read`` | An event is generated when program information is returned. For example, when you list programs or program details. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``quantum-computing.program.delete`` | An event is generated when a program is deleted. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``quantum-computing.program.update`` | An event is generated when a program metadata is updated. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``quantum-computing.job.create`` | An event is generated when a job is started. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``quantum-computing.job.read`` | An event is generated when job information is returned. This includes listing jobs, job details, job results, job interim results, or job logs. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``quantum-computing.job.delete`` | An event is generated when a job is deleted. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``quantum-computing.job.cancel`` | An event is generated when a job is cancelled. |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+

Viewing events
--------------

Events that are generated by an instance of the *YourServiceName* service are automatically forwarded to the IBM Cloud Activity Trackerservice instance that is available in the same location.

IBM Cloud Activity Tracker can have only one instance per location. To view events, you must access the web UI of the IBM Cloud Activity Tracker service in the same location where your service instance is available. For more information, see `Launching the UI <https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-launch>`__.
Loading

0 comments on commit ab7486d

Please sign in to comment.