@@ -342,3 +342,60 @@ We provide the following general recommendations for PostgreSQL settings:
342342 and memory utilization is high.
343343- Utilize faster disk options (higher IOPS) such as SSDs or NVMe drives for
344344 optimal performance enhancement and possibly reduce database load.
345+
346+ ##Operational readiness
347+
348+ Operational readiness in Coder is about ensuring that everything is set up
349+ correctly before launching a platform into production. It involves making sure
350+ that the service is reliable, secure, and easily scales accordingly to user-base
351+ needs. Operational readiness is crucial because it helps prevent issues that
352+ could affect workspace users experience once the platform is live.
353+
354+ Learn about Coder design principles and architectural best practices described
355+ in the
356+ [ Well-Architected Framework] ( https://coder.com/blog/coder-well-architected-framework ) .
357+
358+ ###Configuration
359+
360+ 1 . Identify the required Helm values for configuration.
361+ 1 . Create` values.yaml ` and add it to a version control system._ Note:_ it is
362+ highly recommended that you create a custom` values.yaml ` as opposed to
363+ copying the entire default values.
364+ 1 . Determine the necessary environment variables.
365+
366+ ###Template configuration
367+
368+ 1 . Establish a dedicated user account for the_ Template Administrator_ .
369+ 1 . Maintain Coder templates using version control.
370+ 1 . Consider implementing a GitOps workflow to automatically push new template.
371+ For example, on Github, you can use the
372+ [ Update Coder Template] ( https://github.com/marketplace/actions/update-coder-template )
373+ action.
374+ 1 . Evaluate enabling automatic template updates upon workspace startup.
375+
376+ ###Deployment
377+
378+ 1 . Leverage automation tooling to automate deployment and upgrades of Coder.
379+
380+ ###Observability
381+
382+ 1 . Enable the Prometheus endpoint (environment variable:
383+ ` CODER_PROMETHEUS_ENABLE ` ).
384+ 1 . Deploy a visual monitoring system such as Grafana for metrics visualization.
385+ 1 . Deploy a centralized logs aggregation solution to collect and monitor
386+ application logs.
387+ 1 . Review the[ Prometheus response] ( ../prometheus.md ) and set up alarms on
388+ selected metrics.
389+
390+ ###Database backups
391+
392+ 1 . Prepare internal scripts for dumping and restoring databases.
393+ 1 . Schedule regular database backups, especially before release upgrades.
394+
395+ ###User support
396+
397+ 1 . Incorporate[ support links] ( ../appearance.md#support-links ) into internal
398+ documentation accessible from the user context menu. Ensure that hyperlinks
399+ are valid and lead to up-to-date materials.
400+ 1 . Encourage the use of` coder support bundle ` to allow workspace users to
401+ generate and provide network-related diagnostic data.