This guide is intended to detail and explain configuration properties for Tanzu tc Server.
Introduction
The tc Server CLI, tc-server-10.1
, assumes certain defaults if no configuration properties are provided to it. These defaults are intended to help users get started using tc Server, however, in production environments it is recommended to define configuration properties specific to the environment.
tc Server Configuration properties can be provided via the tc-server-10.1
command line or via configuration files.
When specifying a configuration property on the command line it overrides any matching property keys found in a configuration file.
Specifying Configuration Properties on the command line
All tc-server-10.1
commands accept the command line option --tcs-property
this option takes an argument in the form of key=value
.
Example of overriding the instances.directory
$ tc-server-10.1 create instance --tcs-property instances.directory=/opt/instances
Creating instance 'instance' at '/opt/instances/instance'
Setting JAVA_HOME for instance to '/usr/lib/jvm/java-17-openjdk-amd64'
Initializing git repository for instance configuration.
Using separate layout
Creating bin/setenv.sh
Applying template 'base'
Applying template 'nio'
Configuring instance 'instance' to use tc Runtime version 10.1.30.A
Instance created
Connector summary
Port: 8080 Type: Non-Blocking IO Secure: false Address: undefined
tc Server Configuration Property Files
The tc-server-10.1
command will look in the following locations for property files. The files are read in order and keys defined in previous configuration files will override the former values.
- $TCS_HOME_101/conf/tc-server-10.1.properties
- $HOME/.tc-server/tc-server-10.1.properties
The variables are defined as:
- $TCS_HOME_101 = Base location of the tc Server 10.1.x installation, such as
/opt/tc-server/10.1
- $HOME = The home directory of the user running the
tc-server-10.1
command line tool
In the event that a configuration property is provided on the command line it will override the value defined by the configuration file(s).
tc Server Configuration Properties
The following table lists tc Server Configuration Properties, their defaults, and any notes
key | default value | notes |
---|---|---|
tcserver.control.check.tc-runtime.version | warn | # Specifies whether to refuse to start an tc Runtime instance if the version of tc Runtime is older than the current version of tc Server. Valid options are: warn - print warning to stdout fatal - refuse to start instance with informational message |
tcserver.templates.default | Specifies list of templates to always apply in addition to the default templates (base + nio) which tc Server applies by default. This should be a comma separated list if more than one default is specified. Example: tcserver.templates.default=zgc,nio-ssl | |
tcserver.output.feedback | true | Specifies whether to provide additional feedback during long operations. Valid values are true and false . |
java.home | Specifies the location of the the JRE/JDK to use for the tc Runtime instance. This option is equivalent to –java-home on the command line where a command accepts –java-home. | |
instances.directory | $TCS_HOME/instances | The location for which tc Server instances are stored. |
templates.directory | Specifies the location of custom templates to use with the command. This is in addition to the templates in the tc Server installation directory. | |
tcserver.tmpdir | The value of java.io.tmpdir java system property | Overrides the location used for temporary files. |
ssl.selfsigned.algorithm | SHA512withRSA | Specifies the algorithm used to sign the self signed certificate. This is an expert level property and in general does not require to be set from the default. Self-signed certificates are generated as a convenience and should not be used in a production environment. |
Content feedback and comments