doc: provisioning: Add documentation #11704

juhaylinen · 2023-07-05T11:44:10Z

Add documentation for nrf_provisioning library and sample.
Update changelog.

NordicBuilder · 2023-07-05T11:46:09Z

Test specification

CI/Jenkins/NRF

Skipped

CI/Jenkins/integration

Skipped

Note: This message is automatically posted and updated by the CI

NordicBuilder · 2023-07-05T13:19:17Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

samples/cellular/nrf_provisioning/README.rst

doc/nrf/libraries/networking/nrf_provisioning.rst

melwee01 · 2023-07-06T10:06:07Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+   :local:
+   :depth: 2
+
+The nRF Device provisioning library enables a device to connect to Nordic Semiconductor's provisioning Service.


Unsure about the capitalization: Device Provisioning? Neither capitalized?

If we are talking about the cloud-side provisioning service, I believe the name will be nRF Cloud Provisioning Service, part of nRF Cloud Security Services. I can check with PMT.

Please check the correct name.

Just to check, the service we're talking about here is the Cloud service?

Yes, the Cloud service

samples/cellular/nrf_provisioning/README.rst

melwee01

I have a lot of questions based on the doc writing process for the nRF Cloud Provisioning Service.

If that's the service we refer to in this doc, some changes are required.

melwee01 · 2023-07-06T11:19:32Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+*  A pointer to a callback function which is to be called on modem state changes.
+*  A pointer that must be called once provisioning is done.
+
+If you provide ``null`` as a callback function address argument, a corresponding default callback used.


Suggested change

If you provide ``null`` as a callback function address argument, a corresponding default callback used.

If you provide ``null`` as a callback function address argument, a corresponding default callback is used.

melwee01 · 2023-07-06T11:21:24Z

samples/cellular/nrf_provisioning/README.rst

+The sample shows how the device performs the following actions:
+
+* Connects to nRF Device provisioning Service.
+* Fetches available device specific provisioning commands.


We refer to the group of these commands as the provisioning configuration.

melwee01 · 2023-07-06T11:26:12Z

samples/cellular/nrf_provisioning/README.rst

+* Acts on any AT commands, if available.
+* Reports the results back to the server.
+  In case of errors, stops processing the commands at the first error and reports it back to server.
+* Sends ``FINISHED`` response if all the previous commands are executed without errors provided and ``FINISHED`` is one of the set provisioning commands.


I'm not sure what 'without errors provided and FINISHED is one of the set provisioning commands' means. Possible values for the command status in the Provisioning Service are PENDING, FAILED, IN_PROGRESS, SUCCEEDED, and SKIPPED. Does this refer to the command status or the status of something in the sample, which has different values?

FINISHED refers to the provisioning command which tells to the device that provisioning process has been finished.

OK. So this refers specifically to something in the sample, and not the Provisioning Service.

melwee01 · 2023-07-06T11:27:47Z

samples/cellular/nrf_provisioning/README.rst

+**************
+
+Device side interaction is not required.
+You must fill the command queue at the server side.


Is this referring to the nRF Cloud portal interface? If so, replace 'fill the command queue' with 'define the provisioning configuration'.

You can also define the configuration using the REST API.

melwee01 · 2023-07-06T11:28:28Z

samples/cellular/nrf_provisioning/README.rst

+.. _CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG:
+
+CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG
+   Root CA security tag for the Nordic Semiconductor's provisioning service.


Again, does this refer specifically to the nRF Cloud (secure) Provisioning Service?

melwee01 · 2023-07-06T11:31:46Z

samples/cellular/nrf_provisioning/README.rst

+
+.. include:: /includes/tfm.txt
+
+The sample requires that private device key is installed on the device and the associated Device UUID is obtained from the Identity Service.


Suggested change

The sample requires that private device key is installed on the device and the associated Device UUID is obtained from the Identity Service.

The sample requires that private device key is installed on the device and the associated device UUID is obtained from the Identity Service.

samples/cellular/nrf_provisioning/README.rst

melwee01 · 2023-07-06T11:34:21Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+* After the execution of the commands to report the results.
+
+The library shuts down the modem for writing data to the modem's non-volatile memory, if `AT commands <AT Commands Reference Guide_>`_ are involved.
+Once the memory writes are complete, connection is re-established to report the results back to the server.


Suggested change

Once the memory writes are complete, connection is re-established to report the results back to the server.

Once the memory writes are complete, the connection is re-established to report the results back to the server.

melwee01 · 2023-07-06T11:37:13Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+Once the memory writes are complete, connection is re-established to report the results back to the server.
+The results are reported back to the server when either all the commands succeed or when an error occurs.
+If an error occurs, the results of all the commands that are successfully executed before the error and the erroneous result are reported back to the server.
+All successfully executed commands will be removed from the server-side queue, but if any errors occur, the erroneous command and all the remaining unexecuted commands will be flushed from the queue.


We need to be careful to distinguish this from the provisioning configuration for a claimed device in nRF Cloud: these are, as I understand, the commands we're talking about here.

On the Cloud side, the commands form the provisioining configuration, and the configuration remains in the interface and the service's data about the device until the commands are deleted by the user.

If this is some queue in the network, I'd like that to be a little clearer.

Yes, we are talking about the provisioning configuration here.

All successfully executed commands will be removed from the server-side queue, but if any errors occur, the erroneous command and all the remaining unexecuted commands will be flushed from the queue.

Just to be clear whether you are describing server functionality or device functionality, the removal from the queue and flushing of the queue are done on the server side, not on the device side in this library, correct?

melwee01 · 2023-07-06T11:38:48Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+
+During provisioning, the library first tries to establish the transport for communicating with the service.
+This procedure involves a TLS handshake where the client establishes the correct server.
+The server uses the attestation token or the JWT token generated by the device for authenticating the client.


Cloud-side docs on attestation tokens and the Identity Service will be available next week.

plskeggs · 2023-07-06T19:11:02Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+Once the memory writes are complete, connection is re-established to report the results back to the server.
+The results are reported back to the server when either all the commands succeed or when an error occurs.
+If an error occurs, the results of all the commands that are successfully executed before the error and the erroneous result are reported back to the server.
+All successfully executed commands will be removed from the server-side queue, but if any errors occur, the erroneous command and all the remaining unexecuted commands will be flushed from the queue.


All successfully executed commands will be removed from the server-side queue, but if any errors occur, the erroneous command and all the remaining unexecuted commands will be flushed from the queue.

Just to be clear whether you are describing server functionality or device functionality, the removal from the queue and flushing of the queue are done on the server side, not on the device side in this library, correct?

plskeggs · 2023-07-06T19:15:33Z

samples/cellular/nrf_provisioning/README.rst

+
+.. include:: /includes/tfm.txt
+
+The sample requires that private device key is installed on the device and the associated device UUID is obtained from the Identity Service.


Perhaps "requires that the device's private key" would be clearer.

plskeggs · 2023-07-06T19:19:52Z

samples/cellular/nrf_provisioning/README.rst

+
+	<inf> nrf_provisioning_sample: Establishing LTE link ...
+	<inf> nrf_provisioning_http: Connected
+	<inf> nrf_provisioning: Disconnected from network - provisioning paused


I assume between "Disconnected" and "Connected" on the next line, some actual provisioning is happening?

It might be nice to say so (obviously that requires a change to the code itself, not just this documentation).

Good point. I'll create a new PR for this.

plskeggs · 2023-07-07T18:59:12Z

samples/cellular/nrf_provisioning/README.rst

+
+The sample supports the following development kits:
+
+.. table-from-sample-yaml::


Perhaps use this instead?

.. table-from-rows:: /includes/sample_board_rows.txt :header: heading :rows: nrf9161dk_nrf9161_ns

melwee01 · 2023-07-06T12:18:21Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+
+The TLS handshake needs to be done twice:
+
+* Before requesting commands


Suggested change

* Before requesting commands

* Before requesting commands.

melwee01 · 2023-07-07T13:33:28Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+* AT-command based provisioning commands
+* Writing key-value pair based settings to the :ref:`settings_api` storage
+* TLS secured HTTP as the communication protocol
+* Client authentication with Attestation Token


Suggested change

* Client authentication with Attestation Token

* Client authentication with attestation token

melwee01 · 2023-07-07T13:36:08Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+For now, HTTP is the only supported transport protocol.
+
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_SYS_INIT` - Initializes the client in the system initialization phase
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the provisioning Service


Suggested change

* :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the provisioning Service

* :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the Provisioning Service

melwee01 · 2023-07-07T13:36:17Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_SYS_INIT` - Initializes the client in the system initialization phase
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the provisioning Service
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_HTTP_HOSTNAME` - HTTP API hostname for the provisioning Service


Suggested change

* :kconfig:option:`CONFIG_NRF_PROVISIONING_HTTP_HOSTNAME` - HTTP API hostname for the provisioning Service

* :kconfig:option:`CONFIG_NRF_PROVISIONING_HTTP_HOSTNAME` - HTTP API hostname for the Provisioning Service

melwee01 · 2023-07-07T13:36:27Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+* :kconfig:option:`CONFIG_NRF_PROVISIONING_SYS_INIT` - Initializes the client in the system initialization phase
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the provisioning Service
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_HTTP_HOSTNAME` - HTTP API hostname for the provisioning Service
+* :kconfig:option:`CONFIG_NRF_PROVISIONING_HTTP_PORT` - Port number for the provisioning Service


Suggested change

* :kconfig:option:`CONFIG_NRF_PROVISIONING_HTTP_PORT` - Port number for the provisioning Service

* :kconfig:option:`CONFIG_NRF_PROVISIONING_HTTP_PORT` - Port number for the Provisioning Service

melwee01 · 2023-07-10T06:37:05Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+   Server<<Device    [label="Get commands"];
+   Server>>Device    [label="Return commands"];
+   Device box Device [label="Decode commands"];
+   Device box Device [label="Put modem offline"];


Suggested change

Device box Device [label="Put modem offline"];

Device box Device [label="Set modem offline"];

melwee01 · 2023-07-10T06:37:49Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+   Server<<Device    [label="Get commands"];
+   Server>>Device    [label="Return commands"];
+   Device box Device [label="Decode commands"];
+   Device box Device [label="Put modem offline"];


Suggested change

Device box Device [label="Put modem offline"];

Device box Device [label="Set modem offline"];

melwee01 · 2023-07-10T06:45:35Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+**********************
+
+For testing the client, it is possible to enable Zephyr's shell and provisioning command, which makes it possible to control the client over UART.
+Currently, only the supported subcommand makes it possible to trigger provisioning immediately.


I don't understand this.

Is only immediate provisioning available? Or immediate provisioning is available only using this particular subcommand?

I removed the sentence. There is now more commands available for testing.

melwee01 · 2023-07-10T06:45:59Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+For testing the client, it is possible to enable Zephyr's shell and provisioning command, which makes it possible to control the client over UART.
+Currently, only the supported subcommand makes it possible to trigger provisioning immediately.
+The feature is enabled by selecting :kconfig:option:`CONFIG_NRF_PROVISIONING_SHELL`.
+The shell is meant for testing so production systems must not enable it.


Suggested change

The shell is meant for testing so production systems must not enable it.

The shell is meant for testing. Do not enable it in production.

Every sentence on a separate line.

melwee01 · 2023-07-10T06:47:20Z

samples/cellular/nrf_provisioning/README.rst

+* Acts on any AT commands, if available.
+* Reports the results back to the server.
+  In case of errors, stops processing the commands at the first error and reports it back to server.
+* Sends ``FINISHED`` response if all the previous commands are executed without errors provided and ``FINISHED`` is one of the set provisioning commands.


OK. So this refers specifically to something in the sample, and not the Provisioning Service.

melwee01 · 2023-08-02T10:11:56Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+   :depth: 2
+
+The nRF Device provisioning library enables a device to connect to nRF Cloud Provisioning Service, part of nRF Cloud Security Services.
+It abstracts and hides the details of the transport and the encoding scheme that is used for the payload.


Suggested change

It abstracts and hides the details of the transport and the encoding scheme that is used for the payload.

It abstracts and hides the details of the transport and encoding scheme that are used for the payload.

melwee01 · 2023-08-02T10:12:25Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+
+* AT-command based provisioning commands
+* Writing key-value pair based settings to the :ref:`settings_api` storage
+* TLS secured HTTP as the communication protocol


Suggested change

* TLS secured HTTP as the communication protocol

* TLS-secured HTTP as the communication protocol

melwee01 · 2023-08-02T10:12:56Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+Configuration options for transport protocol
+============================================
+
+For now, HTTP is the only supported transport protocol.


Suggested change

For now, HTTP is the only supported transport protocol.

Currently, HTTP is the only supported transport protocol.

melwee01 · 2023-08-02T10:16:21Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+Initialization
+==============
+
+Once initialized, the provisioning client will run on its own in the background.


Suggested change

Once initialized, the provisioning client will run on its own in the background.

Once initialized, the provisioning client runs on its own in the background.

melwee01 · 2023-08-02T10:16:54Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+==============
+
+Once initialized, the provisioning client will run on its own in the background.
+The provisioning client can be initialized in following two ways:


Suggested change

The provisioning client can be initialized in following two ways:

The provisioning client can be initialized in one of the following ways:

melwee01 · 2023-08-02T10:24:58Z

samples/cellular/nrf_provisioning/README.rst

+
+The sample shows how the device performs the following actions:
+
+* Connects to nRF Device provisioning Service.


If the nRF Cloud service, should be 'nRF Cloud Provisioning Service'.

melwee01 · 2023-08-02T10:25:20Z

samples/cellular/nrf_provisioning/README.rst

+The sample shows how the device performs the following actions:
+
+* Connects to nRF Device provisioning Service.
+* Fetches available device specific provisioning configuration.


Suggested change

* Fetches available device specific provisioning configuration.

* Fetches available device-specific provisioning configuration.

melwee01 · 2023-08-02T10:32:27Z

samples/cellular/nrf_provisioning/README.rst

+**************
+
+Device side interaction is not required.
+You must define the provisioning configuration at the server side.


You could link to https://docs.nrfcloud.com/SecurityServices/ProvisioningService/ProvisioningConfiguration/ProvisioningConfigurationPortal.html here.

melwee01 · 2023-08-02T10:32:57Z

samples/cellular/nrf_provisioning/README.rst

+.. _CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG:
+
+CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG
+   Root CA security tag for the nRF Cloud (secure) Provisioning Service.


Suggested change

Root CA security tag for the nRF Cloud (secure) Provisioning Service.

Root CA security tag for the nRF Cloud Provisioning Service.

melwee01 · 2023-08-02T10:33:39Z

samples/cellular/nrf_provisioning/README.rst

+
+#. |connect_kit|
+#. |connect_terminal|
+#. Add provisioning command(s) to nRF Provisioning Service.


Suggested change

#. Add provisioning command(s) to nRF Provisioning Service.

#. Add a provisioning configuration using the nRF Cloud Provisioning Service.

https://docs.nrfcloud.com/SecurityServices/ProvisioningService/ProvisioningConfiguration/ProvisioningConfigurationPortal.html Link could also go here instead/in addition.

juhaylinen · 2023-08-03T08:19:37Z

@melwee01 I have updated the documentation as requested

melwee01 · 2023-08-07T09:15:16Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+The behavior can be overwritten by providing a unique callback function for the initialization function.
+
+If anything is written to the modem's non-volatile memory, the modem needs to be set in offline mode.
+This is because the modem cannot be connected while any data is to being written to its storage area.


Suggested change

This is because the modem cannot be connected while any data is to being written to its storage area.

This is because the modem cannot be connected while any data is being written to its storage area.

melwee01 · 2023-08-08T11:11:13Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+To use the default implementation, ``NULL`` can be passed as an argument to the :c:func:`nrf_provisioning_init` function.
+Copy and modify the default callback function as necessary.
+
+The library starts provisioning when it initializes and, then according to the configured interval.


Suggested change

The library starts provisioning when it initializes and, then according to the configured interval.

The library starts provisioning when it initializes, then according to the configured interval.

melwee01 · 2023-08-08T11:12:15Z

doc/nrf/libraries/networking/nrf_provisioning.rst

+Once the memory writes are complete, the connection is re-established to report the results back to the server.
+The results are reported back to the server when either all the commands succeed or when an error occurs.
+If an error occurs, the results of all the commands that are successfully executed before the error and the erroneous result are reported back to the server.
+All successfully executed commands will be removed from the server-side queue, but if any errors occur, the erroneous command and all the remaining unexecuted commands will be flushed from the server-side queue.


Suggested change

All successfully executed commands will be removed from the server-side queue, but if any errors occur, the erroneous command and all the remaining unexecuted commands will be flushed from the server-side queue.

All successfully executed commands will be removed from the server-side queue, but if any errors occur, the erroneous command and all the remaining unexecuted commands are removed from the server-side queue.

melwee01 · 2023-08-08T11:13:18Z

samples/cellular/nrf_provisioning/README.rst

+**************
+
+Device side interaction is not required.
+You must define the provisioning configuration at the server side, see `nRF Cloud provisioning configuration`_.


Suggested change

You must define the provisioning configuration at the server side, see `nRF Cloud provisioning configuration`_.

You must define the provisioning configuration at the server side. See `nRF Cloud provisioning configuration`_.

All sentences in separate lines in rst.

melwee01 · 2023-08-08T11:13:47Z

samples/cellular/nrf_provisioning/README.rst

+
+#. |connect_kit|
+#. |connect_terminal|
+#. Add a provisioning configuration using the nRF Cloud Provisioning Service, see `nRF Cloud provisioning configuration`.


Suggested change

#. Add a provisioning configuration using the nRF Cloud Provisioning Service, see `nRF Cloud provisioning configuration`.

#. Add a provisioning configuration using the nRF Cloud Provisioning Service. See `nRF Cloud provisioning configuration`.

Same nitpick as above.

My bad. Thanks, Pekka.

melwee01 · 2023-08-09T10:35:59Z

samples/cellular/nrf_provisioning/README.rst

+#. |connect_kit|
+#. |connect_terminal|
+#. Add a provisioning configuration using the nRF Cloud Provisioning Service.
+#. See `nRF Cloud provisioning configuration`.


Sorry for a further nitpick, but I think this will now render as a numbered step when it was probably intended to be a follow-up to the previous line.

@peknis, I don't know the proper formatting to suggest. What do you think?

Otherwise, LGTM.

peknis · 2023-08-09T10:41:06Z

samples/cellular/nrf_provisioning/README.rst

+#. Add a provisioning configuration using the nRF Cloud Provisioning Service.
+#. See `nRF Cloud provisioning configuration`.


Suggested change

#. Add a provisioning configuration using the nRF Cloud Provisioning Service.

#. See `nRF Cloud provisioning configuration`.

#. Add a provisioning configuration using the nRF Cloud Provisioning Service.

See `nRF Cloud provisioning configuration`.

Add documentation for nrf_provisioning library and sample. Update changelog. Signed-off-by: Juha Ylinen <juha.ylinen@nordicsemi.no>

juhaylinen requested a review from jarlamsa July 5, 2023 11:44

juhaylinen requested review from SeppoTakalo and carlescufi as code owners July 5, 2023 11:44

github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Jul 5, 2023

juhaylinen removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jul 5, 2023

juhaylinen requested review from divipillai and plskeggs July 5, 2023 11:46

juhaylinen force-pushed the provisioning_docs branch from 8c03635 to 33e0c5a Compare July 5, 2023 12:27

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jul 5, 2023

divipillai reviewed Jul 5, 2023

View reviewed changes

peknis requested a review from melwee01 July 6, 2023 06:17

melwee01 reviewed Jul 6, 2023

View reviewed changes

peknis requested changes Jul 6, 2023

View reviewed changes

samples/cellular/nrf_provisioning/README.rst Outdated Show resolved Hide resolved

samples/cellular/nrf_provisioning/README.rst Outdated Show resolved Hide resolved

melwee01 requested changes Jul 6, 2023

View reviewed changes

juhaylinen force-pushed the provisioning_docs branch from 33e0c5a to de4a977 Compare July 6, 2023 12:32

plskeggs approved these changes Jul 6, 2023

View reviewed changes

jarlamsa approved these changes Jul 7, 2023

View reviewed changes

juhaylinen force-pushed the provisioning_docs branch from de4a977 to e0a24c5 Compare July 7, 2023 12:14

juhaylinen removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jul 7, 2023

plskeggs reviewed Jul 7, 2023

View reviewed changes

melwee01 requested changes Jul 10, 2023

View reviewed changes

juhaylinen force-pushed the provisioning_docs branch from e0a24c5 to d24f82e Compare July 31, 2023 11:31

melwee01 requested changes Aug 2, 2023

View reviewed changes

juhaylinen force-pushed the provisioning_docs branch from d24f82e to 77a423c Compare August 3, 2023 08:10

melwee01 reviewed Aug 8, 2023

View reviewed changes

juhaylinen force-pushed the provisioning_docs branch from 77a423c to 4c4554d Compare August 8, 2023 11:32

melwee01 reviewed Aug 9, 2023

View reviewed changes

peknis requested changes Aug 9, 2023

View reviewed changes

doc: provisioning: Add documentation

9bde210

Add documentation for nrf_provisioning library and sample. Update changelog. Signed-off-by: Juha Ylinen <juha.ylinen@nordicsemi.no>

juhaylinen force-pushed the provisioning_docs branch from 4c4554d to 9bde210 Compare August 9, 2023 10:47

peknis approved these changes Aug 9, 2023

View reviewed changes

juhaylinen removed the doc-required PR must not be merged without tech writer approval. label Aug 9, 2023

melwee01 approved these changes Aug 9, 2023

View reviewed changes

nordicjm merged commit 97d0adc into nrfconnect:main Aug 9, 2023
13 checks passed

juhaylinen deleted the provisioning_docs branch August 10, 2023 07:35

	If you provide ``null`` as a callback function address argument, a corresponding default callback used.
	If you provide ``null`` as a callback function address argument, a corresponding default callback is used.


		.. include:: /includes/tfm.txt

		The sample requires that private device key is installed on the device and the associated Device UUID is obtained from the Identity Service.

	Once the memory writes are complete, connection is re-established to report the results back to the server.
	Once the memory writes are complete, the connection is re-established to report the results back to the server.


		The sample supports the following development kits:

		.. table-from-sample-yaml::


		The TLS handshake needs to be done twice:

		* Before requesting commands

	* Client authentication with Attestation Token
	* Client authentication with attestation token

	* :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the provisioning Service
	* :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the Provisioning Service

	Device box Device [label="Put modem offline"];
	Device box Device [label="Set modem offline"];

	The shell is meant for testing so production systems must not enable it.
	The shell is meant for testing. Do not enable it in production.

	It abstracts and hides the details of the transport and the encoding scheme that is used for the payload.
	It abstracts and hides the details of the transport and encoding scheme that are used for the payload.

	* TLS secured HTTP as the communication protocol
	* TLS-secured HTTP as the communication protocol

	For now, HTTP is the only supported transport protocol.
	Currently, HTTP is the only supported transport protocol.

	Once initialized, the provisioning client will run on its own in the background.
	Once initialized, the provisioning client runs on its own in the background.

	The provisioning client can be initialized in following two ways:
	The provisioning client can be initialized in one of the following ways:


		The sample shows how the device performs the following actions:

		* Connects to nRF Device provisioning Service.

	* Fetches available device specific provisioning configuration.
	* Fetches available device-specific provisioning configuration.

	Root CA security tag for the nRF Cloud (secure) Provisioning Service.
	Root CA security tag for the nRF Cloud Provisioning Service.

	#. Add provisioning command(s) to nRF Provisioning Service.
	#. Add a provisioning configuration using the nRF Cloud Provisioning Service.

	This is because the modem cannot be connected while any data is to being written to its storage area.
	This is because the modem cannot be connected while any data is being written to its storage area.

	The library starts provisioning when it initializes and, then according to the configured interval.
	The library starts provisioning when it initializes, then according to the configured interval.

doc: provisioning: Add documentation #11704

doc: provisioning: Add documentation #11704

Conversation

juhaylinen commented Jul 5, 2023

NordicBuilder commented Jul 5, 2023 • edited Loading

Test specification

NordicBuilder commented Jul 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melwee01 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juhaylinen commented Aug 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NordicBuilder commented Jul 5, 2023 •

edited

Loading

	You must define the provisioning configuration at the server side, see `nRF Cloud provisioning configuration`_.
	You must define the provisioning configuration at the server side. See `nRF Cloud provisioning configuration`_.

		#. Add a provisioning configuration using the nRF Cloud Provisioning Service.
		#. See `nRF Cloud provisioning configuration`.