{"config":{"lang":["en"],"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"","title":"Home"},{"location":"commands/crypto/","text":"Crypto encrypt \u00b6 siren crypto encrypt [ --pubkey = public.jwk ] WORDS... Encrypt the words using the public key. The resulting output can only be decrypted using the corresponding private key. decrypt \u00b6 siren crypto decrypt [ --privkey = private.jwk ] CIPHERTEXT Decrypt the encrypted data using the private key. This can only decrypt data that was encrypted using the corresponding public key. genkeys \u00b6 siren crypto genkeys [ --force ] [ --privkey = private.jwk ] [ --pubkey = public.jwk ] Generates a pair of encryption keys. Usually, you\u2019ll want to use the already-created encryption keys. This command should only need to be used if it\u2019s necessary to replace those keys.","title":"Crypto"},{"location":"commands/crypto/#encrypt","text":"siren crypto encrypt [ --pubkey = public.jwk ] WORDS... Encrypt the words using the public key. The resulting output can only be decrypted using the corresponding private key.","title":"encrypt"},{"location":"commands/crypto/#decrypt","text":"siren crypto decrypt [ --privkey = private.jwk ] CIPHERTEXT Decrypt the encrypted data using the private key. This can only decrypt data that was encrypted using the corresponding public key.","title":"decrypt"},{"location":"commands/crypto/#genkeys","text":"siren crypto genkeys [ --force ] [ --privkey = private.jwk ] [ --pubkey = public.jwk ] Generates a pair of encryption keys. Usually, you\u2019ll want to use the already-created encryption keys. This command should only need to be used if it\u2019s necessary to replace those keys.","title":"genkeys"},{"location":"commands/song/","text":"Song convert \u00b6 siren song convert FILE Convert a song to a set of Kubernetes resource descriptions. Until Kubernetes is fully integrated into the CLI, you could deploy a song on a Kubernetes cluster using the command: siren song convert FILE | kubectl apply -f - and remove it with siren song convert FILE | kubectl delete -f - Or, you can save the resources to a file to edit or inspect them before deployment. File format \u00b6 # Choff for Kubernetes. apiVersion : siren.altaire.xyz/v1 kind : Song metadata : # A name is required. name : builder spec : # Global environmental variables which apply to all services. env : name : value service : - # As you can imagine, the image to run. image : altaire/builder-live # Optionally, the command to run in the image. command : command-name # Optionally, name this service. # If there are multiple services, you _must_ name them. name : service-name # Environmental variables which apply to all services. # These override the global variables, if there are any. env : name : value # Publish the service one or more domains publish : - # The port the service is listening on. port : 8081 # Domain name to use. domain : builder.k9.altaire.xyz # Use built-in Altaire auth. auth : true - ...","title":"Song"},{"location":"commands/song/#convert","text":"siren song convert FILE Convert a song to a set of Kubernetes resource descriptions. Until Kubernetes is fully integrated into the CLI, you could deploy a song on a Kubernetes cluster using the command: siren song convert FILE | kubectl apply -f - and remove it with siren song convert FILE | kubectl delete -f - Or, you can save the resources to a file to edit or inspect them before deployment.","title":"convert"},{"location":"commands/song/#file-format","text":"# Choff for Kubernetes. apiVersion : siren.altaire.xyz/v1 kind : Song metadata : # A name is required. name : builder spec : # Global environmental variables which apply to all services. env : name : value service : - # As you can imagine, the image to run. image : altaire/builder-live # Optionally, the command to run in the image. command : command-name # Optionally, name this service. # If there are multiple services, you _must_ name them. name : service-name # Environmental variables which apply to all services. # These override the global variables, if there are any. env : name : value # Publish the service one or more domains publish : - # The port the service is listening on. port : 8081 # Domain name to use. domain : builder.k9.altaire.xyz # Use built-in Altaire auth. auth : true - ...","title":"File format"}]}