Use Cases for Setting Parameters

This topic provides detailed information about changes to make to support use cases for setting parameters. This topic is part of Use Cases for Making Incremental Changes.

Use Cases for Setting Parameters

Use Case/Notes Sample Data Format

1a. Enterprise parameter, adding

File:

enterprise.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = N
PA_EFF_CMP_RSTRT = N

Restart:

  • No restart.

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: NumRetries
      PA_VALUE: '10001'

1b. Enterprise parameter, adding

File:

enterprise.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = Y
PA_EFF_CMP_RSTRT = N

Restart:

  • Full restart. Log in to pod and run siebps. Check timestamp of restart (UTC time).

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: EnableWorkspace
      PA_VALUE: 'True'

2. Enterprise parameter, modifying

File:

enterprise.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = N
PA_EFF_CMP_RSTRT = N

Restart:

  • No restart.

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: NumRetries
      PA_VALUE: '10002'

3. Enterprise parameter, removing configured value

File:

enterprise.yaml

Restart:

  • No restart.

Verification:

  • Default parameter value can be seen in SMC configuration screen.

Delete PA_ALIAS and PA_VALUE pair for a single parameter.

4a. Server parameter, adding

File:

server_edge.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = N
PA_EFF_CMP_RSTRT = N

Restart:

  • No restart .

Verification:

  • Updated parameter value can be seen in SMC configuration screen.
- basic_params:
    - PA_ALIAS: NumRetries
      PA_VALUE: '10005'

4b. Server parameter, adding

File:

server_edge.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = Y
PA_EFF_CMP_RSTRT = Y

Restart:

  • Server restart. All replicas of edge server are restarted (inside pod, stop_server_all and start_server_all are executed). Log in to pod and run siebps. Check timestamp of restart (UTC time).

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: ConfigLdapAuthTimeout
      PA_VALUE: '20'
    - PA_ALIAS: EnableVirtualHosts
      PA_VALUE: 'True'

5. Server parameter, modifying

File:

server_edge.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = Y
PA_EFF_CMP_RSTRT = N

Restart:

  • Server restart. All replicas of edge server are restarted (inside pod, stop_server_all and start_server_all are executed).

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: EnableVirtualHosts
      PA_VALUE: 'False'

6. Server parameter, removing configured value

File:

server_edge.yaml

Restart:

  • No restart.

Verification:

  • Default parameter value can be seen in SMC configuration screen.

Delete PA_ALIAS and PA_VALUE pair for a single parameter.

7a. Component parameter, adding

File:

server_edge.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = Y
PA_EFF_CMP_RSTRT = N

Restart:

  • Server restart. All replicas of edge server are restarted (inside pod, stop_server_all and start_server_all are executed). Log in to pod and run siebps. Check timestamp of restart (UTC time).

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: MaxTasks
      PA_VALUE: '50'

7b. Component parameter, adding

File:

server_edge.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = N
PA_EFF_CMP_RSTRT = Y

Restart:

  • Component restart.

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: ConfigLdapAuthTimeout
      PA_VALUE: '15'

8. Component parameter, modifying

File:

server_edge.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = N
PA_EFF_CMP_RSTRT = N

Restart:

  • No restart.

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

- basic_params:
    - PA_ALIAS: ConfigLdapAuthTimeout
      PA_VALUE: '20'

9. Component parameter, removing configured value

File:

server_edge.yaml

Flag settings:

PA_EFF_SRVR_RSTRT = N
PA_EFF_CMP_RSTRT = N

Restart:

  • No restart.

Verification:

  • Default parameter value can be seen in SMC configuration screen.

Delete PA_ALIAS and PA_VALUE pair for a single parameter.

10. Named subsystem parameter, adding (no restart)

File:

named_subsystem.yaml

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

Specific to named subsystem.

11. Named subsystem parameter, modifying (no restart)

File:

named_subsystem.yaml

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

Specific to named subsystem.

12. Named subsystem parameter, removing (no restart)

File:

named_subsystem.yaml

Verification:

  • SMC configuration screen is updated.

Specific to named subsystem.

13. Component definition parameter, adding (no restart)

File:

comp_definitions.yaml

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

Specific to named subsystem.

14. Component definition parameter, modifying (no restart)

File:

comp_definitions.yaml

Verification:

  • Updated parameter value can be seen in SMC configuration screen.

Specific to named subsystem.

15. Component definition parameter, removing (no restart)

File:

comp_definitions.yaml

Verification:

  • SMC configuration screen is updated.

Specific to named subsystem.